{
"swagger":"2.0",
"schemes":[
"https"
],
"info":{
"title":"REST API for Oracle Eloqua Marketing Cloud Service",
"description":"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.",
"version":"2026.08.07",
"x-summary":"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."
},
"consumes":[
"application/json"
],
"produces":[
"application/json"
],
"paths":{
"/api/rest/2.0/assets/contact/list/folder":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the folder to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest20"
}
}
],
"summary":"Create a folder",
"description":"Creates a folder that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact list folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-list-folder-post",
"x-filename-id":"api-rest-2.0-assets-contact-list-folder-post"
}
},
"/api/rest/2.0/assets/contact/list/folder/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"string"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"extensions",
"in":"query",
"description":"IListFolderService_Parameter_ReadIndividual_extensions_Description",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a folder",
"description":"Retrieves the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact list folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-list-folder-{id}-get",
"x-filename-id":"api-rest-2.0-assets-contact-list-folder-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the folder to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"string"
}
],
"summary":"Update a folder",
"description":"The request body defines the details of the folder to be updated.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact list folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-list-folder-{id}-put",
"x-filename-id":"api-rest-2.0-assets-contact-list-folder-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"string"
}
],
"summary":"Delete a folder",
"description":"Deletes the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact list folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-list-folder-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-contact-list-folder-id-delete"
}
},
"/api/rest/2.0/assets/contact/list/folders":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"string"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"string"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"string"
},
{
"name":"extensions",
"in":"query",
"description":"IListFolderService_Parameter_Search_extensions_Description",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a list of folders",
"description":"Retrieves all folders that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact list folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-list-folders-get",
"x-filename-id":"api-rest-2.0-assets-contact-list-folders-get"
}
},
"/api/rest/2.0/assets/contact/list/folder/{id}/contents":{
"get":{
"operationId":"SearchContentsGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"string"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"string"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"string"
},
{
"name":"extensions",
"in":"query",
"description":"IListFolderService_Parameter_SearchContents_extensions_Description",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a list of folder contents",
"description":"Retrieves all folder contents that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContractObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact list folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-list-folder-{id}-contents-get",
"x-filename-id":"api-rest-2.0-assets-contact-list-folder-id-contents-get"
},
"patch":{
"operationId":"BatchMovePATCHRest20",
"parameters":[
{
"name":"contents",
"in":"body",
"description":"The contents to place in the folder.",
"required":true,
"items":{
"$ref":"#/definitions/MinimalRest20"
},
"schema":{
"type":"array"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"string"
}
],
"summary":"Add content to a folder",
"description":"Places all content into the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/MinimalRest20"
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact list folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-list-folder-{id}-contents-patch",
"x-filename-id":"api-rest-2.0-assets-contact-list-folder-id-contents-patch"
}
},
"/api/rest/2.0/assets/contact/list/folder/root/contents":{
"get":{
"operationId":"SearchRootContentsGETRest20",
"parameters":[
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"string"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"string"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"string"
},
{
"name":"extensions",
"in":"query",
"description":"IListFolderService_Parameter_SearchRootContents_extensions_Description",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a list of folder contents in the root folder",
"description":"Retrieves all folder contents in the root folder that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContractObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact list folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-list-folder-root-contents-get",
"x-filename-id":"api-rest-2.0-assets-contact-list-folder-root-contents-get"
}
},
"/api/rest/2.0/assets/contact/list/folder/root":{
"get":{
"operationId":"ReadRootFolderGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"extensions",
"in":"query",
"description":"IListFolderService_Parameter_ReadRootFolder_extensions_Description",
"required":false,
"type":"string"
}
],
"summary":"Retrieve the root folder",
"description":"Retrieves the root folder.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact list folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-list-folder-root-get",
"x-filename-id":"api-rest-2.0-assets-contact-list-folder-root-get"
}
},
"/api/rest/1.0/assets/form":{
"post":{
"operationId":"CreateIndividualPOSTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the form to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/FormRest10"
}
}
],
"summary":"Create a form",
"description":"Creates a form that matches the criteria specified by the request body. Note: You can also create a form via REST 2.0 by using the endpoint REST/2.0/assets/form.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/FormRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Forms"
],
"x-internal-id":"api-rest-1.0-assets-form-post",
"x-filename-id":"api-rest-1.0-assets-form-post"
}
},
"/api/rest/1.0/assets/form/{id}":{
"get":{
"operationId":"ReadIndividualGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the form.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a form",
"description":"Retrieves the form specified by the id parameter. Note: You can also retrieve a form via REST 2.0 by using the endpoint REST/2.0/assets/form/{id}.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/FormRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Forms"
],
"x-internal-id":"api-rest-1.0-assets-form-{id}-get",
"x-filename-id":"api-rest-1.0-assets-form-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the form to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/FormRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the form.",
"required":true,
"type":"integer"
}
],
"summary":"Update a form",
"description":"Updates the form specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/FormRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Forms"
],
"x-internal-id":"api-rest-1.0-assets-form-{id}-put",
"x-filename-id":"api-rest-1.0-assets-form-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the form.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a form",
"description":"Deletes the form specified by the id parameter. Note: You can also delete a form via REST 2.0 by using the endpoint REST/2.0/assets/form/{id}.",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Forms"
],
"x-internal-id":"api-rest-1.0-assets-form-{id}-delete",
"x-filename-id":"api-rest-1.0-assets-form-id-delete"
}
},
"/api/rest/1.0/assets/forms":{
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the form was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of forms",
"description":"Retrieves all forms that match the criteria specified by the request parameters. Note: You can also retrieve a list of forms via REST 2.0 by using the endpoint REST/2.0/assets/forms.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultFormRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Forms"
],
"x-internal-id":"api-rest-1.0-assets-forms-get",
"x-filename-id":"api-rest-1.0-assets-forms-get"
}
},
"/api/rest/2.0/assets/sms/senderCodes":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the sender code was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of sender codes",
"description":"Retrieves all sender codes that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultSenderCodeRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS codes"
],
"x-internal-id":"api-rest-2.0-assets-sms-senderCodes-get",
"x-filename-id":"api-rest-2.0-assets-sms-sendercodes-get"
}
},
"/api/rest/2.0/assets/hyperlink/folder":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the folder to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest20"
}
}
],
"summary":"Create a folder",
"description":"Creates a folder that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Hyperlink folders"
],
"x-internal-id":"api-rest-2.0-assets-hyperlink-folder-post",
"x-filename-id":"api-rest-2.0-assets-hyperlink-folder-post"
}
},
"/api/rest/2.0/assets/hyperlink/folder/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a folder",
"description":"Retrieves the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Hyperlink folders"
],
"x-internal-id":"api-rest-2.0-assets-hyperlink-folder-{id}-get",
"x-filename-id":"api-rest-2.0-assets-hyperlink-folder-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the folder to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
}
],
"summary":"Update a folder",
"description":"The request body defines the details of the folder to be updated.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Hyperlink folders"
],
"x-internal-id":"api-rest-2.0-assets-hyperlink-folder-{id}-put",
"x-filename-id":"api-rest-2.0-assets-hyperlink-folder-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a folder",
"description":"Deletes the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Hyperlink folders"
],
"x-internal-id":"api-rest-2.0-assets-hyperlink-folder-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-hyperlink-folder-id-delete"
}
},
"/api/rest/2.0/assets/hyperlink/folders":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of folders",
"description":"Retrieves all folders that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Hyperlink folders"
],
"x-internal-id":"api-rest-2.0-assets-hyperlink-folders-get",
"x-filename-id":"api-rest-2.0-assets-hyperlink-folders-get"
}
},
"/api/rest/2.0/assets/hyperlink/folder/{id}/contents":{
"get":{
"operationId":"SearchContentsGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of folder contents",
"description":"Retrieves all folder contents that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContractObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Hyperlink folders"
],
"x-internal-id":"api-rest-2.0-assets-hyperlink-folder-{id}-contents-get",
"x-filename-id":"api-rest-2.0-assets-hyperlink-folder-id-contents-get"
},
"patch":{
"operationId":"BatchMovePATCHRest20",
"parameters":[
{
"name":"contents",
"in":"body",
"description":"The contents to place in the folder.",
"required":true,
"items":{
"$ref":"#/definitions/MinimalRest20"
},
"schema":{
"type":"array"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"string"
}
],
"summary":"Add content to a folder",
"description":"Places all content into the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/MinimalRest20"
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Hyperlink folders"
],
"x-internal-id":"api-rest-2.0-assets-hyperlink-folder-{id}-contents-patch",
"x-filename-id":"api-rest-2.0-assets-hyperlink-folder-id-contents-patch"
}
},
"/api/rest/2.0/assets/hyperlink/folder/root/contents":{
"get":{
"operationId":"SearchRootContentsGETRest20",
"parameters":[
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of folder contents in the root folder",
"description":"Retrieves all folder contents in the root folder that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContractObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Hyperlink folders"
],
"x-internal-id":"api-rest-2.0-assets-hyperlink-folder-root-contents-get",
"x-filename-id":"api-rest-2.0-assets-hyperlink-folder-root-contents-get"
}
},
"/api/rest/2.0/assets/hyperlink/folder/root":{
"get":{
"operationId":"ReadRootFolderGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve the root folder",
"description":"Retrieves the root folder.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Hyperlink folders"
],
"x-internal-id":"api-rest-2.0-assets-hyperlink-folder-root-get",
"x-filename-id":"api-rest-2.0-assets-hyperlink-folder-root-get"
}
},
"/api/rest/2.0/assets/hyperlink/folder/root/folders":{
"get":{
"operationId":"SearchRootSubFoldersGETRest20",
"parameters":[
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of subfolders in the root folder",
"description":"Retrieves all subfolders in the root folder that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Hyperlink folders"
],
"x-internal-id":"api-rest-2.0-assets-hyperlink-folder-root-folders-get",
"x-filename-id":"api-rest-2.0-assets-hyperlink-folder-root-folders-get"
}
},
"/api/rest/2.0/assets/hyperlink/folder/{id}/folders":{
"get":{
"operationId":"SearchSubFoldersGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of subfolders",
"description":"Retrieves all subfolders that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Hyperlink folders"
],
"x-internal-id":"api-rest-2.0-assets-hyperlink-folder-{id}-folders-get",
"x-filename-id":"api-rest-2.0-assets-hyperlink-folder-id-folders-get"
}
},
"/api/rest/1.0/assets/landingPage":{
"post":{
"operationId":"CreateIndividualPOSTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the landing page to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/LandingPageRest10"
}
}
],
"summary":"Create a landing page",
"description":"Creates a landing page that matches the criteria specified by the request body for htmlContent with a type of RawHtmlContent.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/LandingPageRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Landing pages"
],
"x-internal-id":"api-rest-1.0-assets-landingPage-post",
"x-filename-id":"api-rest-1.0-assets-landingpage-post"
}
},
"/api/rest/1.0/assets/landingPage/{id}":{
"get":{
"operationId":"ReadIndividualGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the landing page to retrieve.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a landing page",
"description":"Retrieves the landing page specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/LandingPageRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Landing pages"
],
"x-internal-id":"api-rest-1.0-assets-landingPage-{id}-get",
"x-filename-id":"api-rest-1.0-assets-landingpage-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the landing page to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/LandingPageRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the landing page to update.",
"required":true,
"type":"integer"
}
],
"summary":"Update a landing page",
"description":"Updates the landing page specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/LandingPageRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Landing pages"
],
"x-internal-id":"api-rest-1.0-assets-landingPage-{id}-put",
"x-filename-id":"api-rest-1.0-assets-landingpage-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the landing page to delete.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a landing page",
"description":"Deletes the landing page specified by the id parameter.",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Landing pages"
],
"x-internal-id":"api-rest-1.0-assets-landingPage-{id}-delete",
"x-filename-id":"api-rest-1.0-assets-landingpage-id-delete"
}
},
"/api/rest/1.0/assets/landingPages":{
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"Unix timestamp for the date and time the external asset was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of landing pages",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultLandingPageRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Landing pages"
],
"x-internal-id":"api-rest-1.0-assets-landingPages-get",
"x-filename-id":"api-rest-1.0-assets-landingpages-get"
}
},
"/api/rest/1.0/assets/microsite":{
"post":{
"operationId":"CreateIndividualPOSTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the microsite to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/MicrositeRest10"
}
}
],
"summary":"Create a microsite",
"description":"Creates a microsite that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/MicrositeRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Microsites"
],
"x-internal-id":"api-rest-1.0-assets-microsite-post",
"x-filename-id":"api-rest-1.0-assets-microsite-post"
}
},
"/api/rest/1.0/assets/microsite/{id}":{
"get":{
"operationId":"ReadIndividualGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the microsite.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a microsite",
"description":"Retrieves a microsite specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/MicrositeRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Microsites"
],
"x-internal-id":"api-rest-1.0-assets-microsite-{id}-get",
"x-filename-id":"api-rest-1.0-assets-microsite-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the microsite to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/MicrositeRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the microsite.",
"required":true,
"type":"integer"
}
],
"summary":"Update a microsite",
"description":"Updates a microsite specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/MicrositeRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Microsites"
],
"x-internal-id":"api-rest-1.0-assets-microsite-{id}-put",
"x-filename-id":"api-rest-1.0-assets-microsite-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the microsite. This is a read-only property.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a microsite",
"description":"Deletes a microsite specified by the id parameter.",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Microsites"
],
"x-internal-id":"api-rest-1.0-assets-microsite-{id}-delete",
"x-filename-id":"api-rest-1.0-assets-microsite-id-delete"
}
},
"/api/rest/1.0/assets/microsites":{
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the microsite was last updated.",
"required":false,
"type":"integer"
},
{
"name":"isCertificateProvisioned",
"in":"query",
"description":"Boolean query parameter to filter microsites provisioned using the Automated Certificate Management system. For example, ?isCertificateProvisioned=true. Set to false by default. For more information about Automated Certificate Management, refer to the help center.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a list of microsites",
"description":"Retrieves all microsites that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultMicrositeRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Microsites"
],
"x-internal-id":"api-rest-1.0-assets-microsites-get",
"x-filename-id":"api-rest-1.0-assets-microsites-get"
}
},
"/api/rest/2.0/assets/sms/invalidResponseMessages":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the message was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of message",
"description":"Retrieves all message that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultInvalidResponseMessageRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS invalid keyword messages"
],
"x-internal-id":"api-rest-2.0-assets-sms-invalidResponseMessages-get",
"x-filename-id":"api-rest-2.0-assets-sms-invalidresponsemessages-get"
}
},
"/api/rest/2.0/assets/sms/invalidResponseMessage/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the message",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a message",
"description":"Retrieves the message specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/InvalidResponseMessageRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS invalid keyword messages"
],
"x-internal-id":"api-rest-2.0-assets-sms-invalidResponseMessage-{id}-get",
"x-filename-id":"api-rest-2.0-assets-sms-invalidresponsemessage-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the message to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/InvalidResponseMessageRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the message",
"required":true,
"type":"string"
}
],
"summary":"Update a message",
"description":"The request body defines the details of the message to be updated.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/InvalidResponseMessageRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS invalid keyword messages"
],
"x-internal-id":"api-rest-2.0-assets-sms-invalidResponseMessage-{id}-put",
"x-filename-id":"api-rest-2.0-assets-sms-invalidresponsemessage-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the message",
"required":true,
"type":"integer"
}
],
"summary":"Delete a message",
"description":"Deletes the message specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS invalid keyword messages"
],
"x-internal-id":"api-rest-2.0-assets-sms-invalidResponseMessage-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-sms-invalidresponsemessage-id-delete"
}
},
"/api/rest/2.0/assets/sms/invalidResponseMessage":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the message to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/InvalidResponseMessageRest20"
}
}
],
"summary":"Create a message",
"description":"Creates a message that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/InvalidResponseMessageRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS invalid keyword messages"
],
"x-internal-id":"api-rest-2.0-assets-sms-invalidResponseMessage-post",
"x-filename-id":"api-rest-2.0-assets-sms-invalidresponsemessage-post"
}
},
"/api/rest/2.0/assets/program":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the program to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/ProgramRest20"
}
}
],
"summary":"Create a program",
"description":"Creates a program.",
"responses":{
"201":{
"description":"Created",
"schema":{
"$ref":"#/definitions/ProgramRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Programs"
],
"x-internal-id":"api-rest-2.0-assets-program-post",
"x-filename-id":"api-rest-2.0-assets-program-post"
}
},
"/api/rest/2.0/assets/program/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the program to retrieve.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a program",
"description":"Retrieves the program specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/ProgramRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Programs"
],
"x-internal-id":"api-rest-2.0-assets-program-{id}-get",
"x-filename-id":"api-rest-2.0-assets-program-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the program to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/ProgramRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the program to update.",
"required":true,
"type":"integer"
}
],
"summary":"Update a program",
"description":"Updates the program specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/ProgramRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Programs"
],
"x-internal-id":"api-rest-2.0-assets-program-{id}-put",
"x-filename-id":"api-rest-2.0-assets-program-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the program to delete.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a program",
"description":"Deletes the program specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Programs"
],
"x-internal-id":"api-rest-2.0-assets-program-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-program-id-delete"
}
},
"/api/rest/2.0/assets/program/active/{id}":{
"post":{
"operationId":"ActivateIndividualPOSTRest20",
"parameters":[
{
"name":"scheduledFor",
"in":"query",
"description":"The date and time for the program to activate on expressed in Unix time. Alternatively, you can activate the campaign immediately by specifying now.",
"required":false,
"type":"string"
},
{
"name":"id",
"in":"path",
"description":"Id of the program.",
"required":true,
"type":"integer"
},
{
"name":"runAsUserId",
"in":"query",
"description":"The username to activate the program",
"required":false,
"type":"integer"
}
],
"summary":"Activate a program",
"description":"Activates the program specified by the id parameter.",
"responses":{
"201":{
"description":"Created",
"schema":{
"$ref":"#/definitions/ProgramRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Programs"
],
"x-internal-id":"api-rest-2.0-assets-program-active-{id}-post",
"x-filename-id":"api-rest-2.0-assets-program-active-id-post"
}
},
"/api/rest/2.0/assets/program/draft/{id}":{
"post":{
"operationId":"DeactivateIndividualPOSTRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the program to deactivate.",
"required":true,
"type":"integer"
}
],
"summary":"Deactivate a program",
"description":"Deactivates the program specified by the id parameter.",
"responses":{
"201":{
"description":"Created",
"schema":{
"$ref":"#/definitions/ProgramRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Programs"
],
"x-internal-id":"api-rest-2.0-assets-program-draft-{id}-post",
"x-filename-id":"api-rest-2.0-assets-program-draft-id-post"
}
},
"/api/rest/2.0/assets/program/pause/{id}":{
"post":{
"operationId":"PauseIndividualPOSTRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the program to pause.",
"required":true,
"type":"integer"
}
],
"summary":"Pause a program",
"description":"Pauses the program specified by the id parameter.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/ProgramRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Programs"
],
"x-internal-id":"api-rest-2.0-assets-program-pause-{id}-post",
"x-filename-id":"api-rest-2.0-assets-program-pause-id-post"
}
},
"/api/rest/2.0/assets/programs":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. The default value is minimal.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the program was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of programs",
"description":"Retrieves a list of programs.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultProgramRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Programs"
],
"x-internal-id":"api-rest-2.0-assets-programs-get",
"x-filename-id":"api-rest-2.0-assets-programs-get"
}
},
"/api/rest/2.0/assets/lookupTable/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the lookup table.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. The default value is minimal.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a lookup table.",
"description":"Retrieves a single lookup table specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/LookupTableRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Lookup tables"
],
"x-internal-id":"api-rest-2.0-assets-lookupTable-{id}-get",
"x-filename-id":"api-rest-2.0-assets-lookuptable-id-get"
}
},
"/api/rest/2.0/assets/lookupTables":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"The number of results returned in the request.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the lookup table was last updated. This is a read-only property.",
"required":false,
"type":"integer"
}
],
"summary":"Search for a Lookup table by Name field",
"description":"Search for a Lookup table by Name field ",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultLookupTableRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Lookup tables"
],
"x-internal-id":"api-rest-2.0-assets-lookupTables-get",
"x-filename-id":"api-rest-2.0-assets-lookuptables-get"
}
},
"/api/rest/2.0/assets/lookupTable/{id}/lookupTableEntries":{
"get":{
"operationId":"SearchEntriesGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Search for Lookup table entries by ID field",
"required":true,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
}
],
"summary":"Search for Lookup table Entries by Lookup or Replacement field",
"description":"Search for Lookup table Entries by Lookup or Replacement field",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultLookupTableEntryRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Lookup tables"
],
"x-internal-id":"api-rest-2.0-assets-lookupTable-{id}-lookupTableEntries-get",
"x-filename-id":"api-rest-2.0-assets-lookuptable-id-lookuptableentries-get"
}
},
"/api/rest/2.0/assets/lookupTable/{lookupTableId}/lookupTableEntry/{elementId}":{
"delete":{
"operationId":"DeleteElementIndividualDELETERest20",
"parameters":[
{
"name":"lookupTableId",
"in":"path",
"description":"Id of the lookup table",
"required":true,
"type":"integer"
},
{
"name":"elementId",
"in":"path",
"description":"ElementId of the lookup table",
"required":true,
"type":"integer"
}
],
"summary":"Delete Lookup Table Entry by ID",
"description":"Delete Lookup Table Entry by ID",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Lookup tables"
],
"x-internal-id":"api-rest-2.0-assets-lookupTable-{lookupTableId}-lookupTableEntry-{elementId}-delete",
"x-filename-id":"api-rest-2.0-assets-lookuptable-lookuptableid-lookuptableentry-elementid-delete"
},
"put":{
"operationId":"UpdateElementIndividualPUTRest20",
"parameters":[
{
"name":"lookupTableId",
"in":"path",
"description":"Id of the lookup table",
"required":true,
"type":"integer"
},
{
"name":"elementId",
"in":"path",
"description":"ElementId of the lookup table",
"required":true,
"type":"integer"
},
{
"name":"entry",
"in":"body",
"description":"The lookup table entry",
"required":true,
"schema":{
"$ref":"#/definitions/LookupTableEntryRest20"
}
}
],
"summary":"Update existing Lookup Table Entry",
"description":"Update existing Lookup Table Entry",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/LookupTableEntryRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Lookup tables"
],
"x-internal-id":"api-rest-2.0-assets-lookupTable-{lookupTableId}-lookupTableEntry-{elementId}-put",
"x-filename-id":"api-rest-2.0-assets-lookuptable-lookuptableid-lookuptableentry-elementid-put"
}
},
"/api/rest/2.0/assets/lookupTable/{id}/lookupTableEntry":{
"post":{
"operationId":"AddEntryPOSTRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the lookup table",
"required":true,
"type":"integer"
},
{
"name":"entry",
"in":"body",
"description":"The lookup table entry",
"required":true,
"schema":{
"$ref":"#/definitions/LookupTableEntryRest20"
}
}
],
"summary":"Add lookup table Entry for an existing lookup table",
"description":"Add lookup table Entry for an existing lookup table",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/LookupTableEntryRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Lookup tables"
],
"x-internal-id":"api-rest-2.0-assets-lookupTable-{id}-lookupTableEntry-post",
"x-filename-id":"api-rest-2.0-assets-lookuptable-id-lookuptableentry-post"
}
},
"/api/rest/1.0/assets/image/{id}":{
"get":{
"operationId":"ReadIndividualGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the image.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve an image",
"description":"Retrieves the image specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/ImageFileRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Images"
],
"x-internal-id":"api-rest-1.0-assets-image-{id}-get",
"x-filename-id":"api-rest-1.0-assets-image-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the image to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/ImageFileRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the image to update.",
"required":true,
"type":"integer"
}
],
"summary":"Update an image",
"description":"Updates the image specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/ImageFileRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Images"
],
"x-internal-id":"api-rest-1.0-assets-image-{id}-put",
"x-filename-id":"api-rest-1.0-assets-image-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the image to delete.",
"required":true,
"type":"integer"
}
],
"summary":"Delete an image",
"description":"Deletes the image specified by the id parameter.",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Images"
],
"x-internal-id":"api-rest-1.0-assets-image-{id}-delete",
"x-filename-id":"api-rest-1.0-assets-image-id-delete"
}
},
"/api/rest/1.0/assets/image/content":{
"post":{
"operationId":"CreateUploadImagePOSTRest10",
"parameters":[
],
"summary":"Upload an image",
"description":"Uploads an image to Eloqua.\r\n\r\nWhen uploading an image, include a header 'Content-Type: multipart/form-data' in the request and post the image as binary data.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/ImageFileRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Images"
],
"x-internal-id":"api-rest-1.0-assets-image-content-post",
"x-filename-id":"api-rest-1.0-assets-image-content-post"
}
},
"/api/rest/1.0/assets/images":{
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the image was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of images",
"description":"Retrieves all images that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultImageRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Images"
],
"x-internal-id":"api-rest-1.0-assets-images-get",
"x-filename-id":"api-rest-1.0-assets-images-get"
}
},
"/api/rest/2.0/data/auditLog/reportExport":{
"post":{
"operationId":"QueueReportExportPOSTRest20",
"parameters":[
{
"name":"request",
"in":"body",
"description":"Audit log export request",
"required":true,
"schema":{
"$ref":"#/definitions/AuditLogReportRequestRest20"
}
}
],
"summary":"Initiate an audit log export",
"description":"Creates a request for an audit log export that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Request for the audit log has been registered. An email containing a link to the exported data will be sent to the email address for export notification"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Audit logs"
],
"x-internal-id":"api-rest-2.0-data-auditLog-reportExport-post",
"x-filename-id":"api-rest-2.0-data-auditlog-reportexport-post"
}
},
"/api/bulk/2.0/campaignResponses/exports":{
"get":{
"tags":[
"Bulk/2.0/campaignResponses"
],
"summary":"Retrieve a list of campaign response export definitions",
"description":"Retrieves a list of campaign response export definitions. See Using the campaign response endpoints in the Oracle Eloqua Developer Help Center for more complete information about these endpoints.",
"operationId":"GetCampaignResponseExportSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CampaignResponseExportSearchResponse",
"description":"The response body contains information about the campaign response export definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items returned.",
"type":"array",
"items":{
"$ref":"#/definitions/Export"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-campaignResponses-exports-get",
"x-filename-id":"api-bulk-2.0-campaignresponses-exports-get"
},
"post":{
"tags":[
"Bulk/2.0/campaignResponses"
],
"summary":"Create a campaign response export definition",
"description":"Creates a campaign response export definition. See Using the campaign response endpoints in the Oracle Eloqua Developer Help Center for more complete information about these endpoints.",
"operationId":"PostCampaignResponseExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"CampaignResponseExportIndividual",
"in":"body",
"description":"The request body contains details of the campaign response export definition.",
"required":true,
"schema":{
"title":"CampaignResponseExportIndividual",
"description":"The request body defines the details of the campaign response export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"OK.",
"schema":{
"title":"CampaignResponseExportIndividualResponse",
"description":"The response body includes information about the campaign response export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-campaignResponses-exports-post",
"x-filename-id":"api-bulk-2.0-campaignresponses-exports-post"
}
},
"/api/bulk/2.0/campaignResponses/exports/{id}":{
"get":{
"tags":[
"Bulk/2.0/campaignResponses"
],
"summary":"Retrieve a campaign response export definition",
"description":"Retrieves a single campaign response export definition. See Using the campaign response endpoints in the Oracle Eloqua Developer Help Center for more complete information about these endpoints.",
"operationId":"GetCampaignResponseExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the campaign response export.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CampaignResponseExportIndividualResponse",
"description":"The response body includes information about the campaign response export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-campaignResponses-exports-{id}-get",
"x-filename-id":"api-bulk-2.0-campaignresponses-exports-id-get"
},
"put":{
"tags":[
"Bulk/2.0/campaignResponses"
],
"summary":"Update a campaign response export definition",
"description":"Updates a campaign response export definition. See Using the campaign response endpoints in the Oracle Eloqua Developer Help Center for more complete information about these endpoints.",
"operationId":"PutCampaignResponseExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the campaign response export.",
"required":true,
"type":"integer"
},
{
"name":"CampaignResponseExportIndividual",
"in":"body",
"description":"The request body contains details of the campaign response export definition.",
"required":true,
"schema":{
"title":"CampaignResponseExportIndividual",
"description":"The request body defines the details of the campaign response export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CampaignResponseExportIndividualResponse",
"description":"The response body includes information about the campaign response export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-campaignResponses-exports-{id}-put",
"x-filename-id":"api-bulk-2.0-campaignresponses-exports-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/campaignResponses"
],
"summary":"Delete a campaign response export definition",
"description":"Deletes a campaign response export definition. See Using the campaign response endpoints in the Oracle Eloqua Developer Help Center for more complete information about these endpoints.",
"operationId":"DeleteCampaignResponseExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the campaign response export.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-campaignResponses-exports-{id}-delete",
"x-filename-id":"api-bulk-2.0-campaignresponses-exports-id-delete"
}
},
"/api/bulk/2.0/campaignResponses/exports/{id}/data":{
"get":{
"tags":[
"Bulk/2.0/campaignResponses"
],
"summary":"Retrieve the synced data for a campaign response export definition",
"description":"Retrieves the synced data for a campaign response export definition. We always recommend using the retrieve an export sync's data endpoint to retrieve data. See Using the campaign response endpoints in the Oracle Eloqua Developer Help Center for more complete information about these endpoints.",
"operationId":"GetCampaignResponseExportDataQuery",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the campaign response export.",
"required":true,
"type":"integer"
},
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CampaignResponseExportDataQueryResponse",
"description":"The response body includes information about the synced data for the campaign response export definition.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items returned.",
"type":"array",
"items":{
"type":"object"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-campaignResponses-exports-{id}-data-get",
"x-filename-id":"api-bulk-2.0-campaignresponses-exports-id-data-get"
},
"delete":{
"tags":[
"Bulk/2.0/campaignResponses"
],
"summary":"Delete the synced data for a campaign response export definition",
"description":"Deletes the synced data for a campaign response export definition. See Using the campaign response endpoints in the Oracle Eloqua Developer Help Center for more complete information about these endpoints.",
"operationId":"DeleteCampaignResponseExportDataQuery",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the campaign response export.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-campaignResponses-exports-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-campaignresponses-exports-id-data-delete"
}
},
"/api/bulk/2.0/campaignResponses/fields/{id}":{
"get":{
"tags":[
"Bulk/2.0/campaignResponses"
],
"summary":"Retrieve a campaign response field definition",
"description":"This endpoint is not valid.",
"operationId":"GetCampaignResponseFieldIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The campaign response field's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CampaignResponseFieldIndividualResponse",
"description":"The response body contains information about the campaign response object field definition.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the campaign response field was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the campaign response field. This is a read-only property.",
"type":"string"
},
"dataType":{
"$ref":"#/definitions/DataType"
},
"defaultValue":{
"title":"defaultValue",
"description":"The campaign response field's default value.",
"type":"string"
},
"hasNotNullConstraint":{
"title":"hasNotNullConstraint",
"description":"Indicates whether the campaign response field can have null values (i.e. empty).",
"type":"boolean"
},
"hasReadOnlyConstraint":{
"title":"hasReadOnlyConstraint",
"description":"Indicates whether the field can be written to.",
"type":"boolean"
},
"hasUniquenessConstraint":{
"title":"hasUniquenessConstraint",
"description":"Indicates whether the field must have a unique value.",
"type":"boolean"
},
"internalName":{
"title":"internalName",
"description":"The field's internal name (used to uniquely identify it).",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the campaign response field definition.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the campaign response field was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-campaignResponses-fields-{id}-get",
"x-filename-id":"api-bulk-2.0-campaignresponses-fields-id-get"
}
},
"/api/bulk/2.0/campaignResponses/fields":{
"get":{
"tags":[
"Bulk/2.0/campaignResponses"
],
"summary":"Retrieve all campaign response fields",
"description":"Retrieves all campaign response fields that could be included in an campaign response import or export definition. See Using the campaign response endpoints in the Oracle Eloqua Developer Help Center for more complete information about these endpoints.",
"operationId":"GetCampaignResponseFieldSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CampaignResponseFieldSearchResponse",
"description":"The response body contains information about the campaign response field definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items returned.",
"type":"array",
"items":{
"$ref":"#/definitions/CampaignResponseField"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-campaignResponses-fields-get",
"x-filename-id":"api-bulk-2.0-campaignresponses-fields-get"
}
},
"/api/bulk/2.0/campaignResponses/imports":{
"get":{
"tags":[
"Bulk/2.0/campaignResponses"
],
"summary":"Retrieve a list of campaign response import definitions",
"description":"Retrieves a list of campaign response import definitions. See Using the campaign response endpoints in the Oracle Eloqua Developer Help Center for more complete information about these endpoints.",
"operationId":"GetCampaignResponseImportSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CampaignResponseImportSearchResponse",
"description":"The response body contains information about the campaign response import definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items returned.",
"type":"array",
"items":{
"$ref":"#/definitions/Import"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-campaignResponses-imports-get",
"x-filename-id":"api-bulk-2.0-campaignresponses-imports-get"
},
"post":{
"tags":[
"Bulk/2.0/campaignResponses"
],
"summary":"Create a campaign response import definition",
"description":"Creates a campaign response import definition. See Using the campaign response endpoints in the Oracle Eloqua Developer Help Center for more complete information about these endpoints.",
"operationId":"PostCampaignResponseImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"CampaignResponseImportIndividual",
"in":"body",
"description":"The request body contains details of the campaign response import definition.",
"required":true,
"schema":{
"title":"CampaignResponseImportIndividual",
"description":"The request body defines the details of the campaign response import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"id":{
"title":"id",
"description":"This property is not used.",
"type":"integer"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"serviceInstanceId":{
"title":"serviceInstanceId",
"description":"Your service instance id.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"OK.",
"schema":{
"title":"CampaignResponseImportIndividualResponse",
"description":"The response body includes information about the campaign response import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"serviceInstanceId":{
"title":"serviceInstanceId",
"description":"Your service instance id.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-campaignResponses-imports-post",
"x-filename-id":"api-bulk-2.0-campaignresponses-imports-post"
}
},
"/api/bulk/2.0/campaignResponses/imports/{id}":{
"get":{
"tags":[
"Bulk/2.0/campaignResponses"
],
"summary":"Retrieve a campaign response import definition",
"description":"Retrieves a single campaign response import definition. See Using the campaign response endpoints in the Oracle Eloqua Developer Help Center for more complete information about these endpoints.",
"operationId":"GetCampaignResponseImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"This property is not used.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CampaignResponseImportIndividualResponse",
"description":"The response body includes information about the campaign response import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"serviceInstanceId":{
"title":"serviceInstanceId",
"description":"Your service instance id.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-campaignResponses-imports-{id}-get",
"x-filename-id":"api-bulk-2.0-campaignresponses-imports-id-get"
},
"put":{
"tags":[
"Bulk/2.0/campaignResponses"
],
"summary":"Update a campaign response import definition",
"description":"Updates a campaign response import definition. See Using the campaign response endpoints in the Oracle Eloqua Developer Help Center for more complete information about these endpoints.",
"operationId":"PutCampaignResponseImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"This property is not used.",
"required":true,
"type":"integer"
},
{
"name":"CampaignResponseImportIndividual",
"in":"body",
"description":"The request body contains details of the campaign response import definition.",
"required":true,
"schema":{
"title":"CampaignResponseImportIndividual",
"description":"The request body defines the details of the campaign response import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"id":{
"title":"id",
"description":"This property is not used.",
"type":"integer"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"serviceInstanceId":{
"title":"serviceInstanceId",
"description":"Your service instance id.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CampaignResponseImportIndividualResponse",
"description":"The response body includes information about the campaign response import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"serviceInstanceId":{
"title":"serviceInstanceId",
"description":"Your service instance id.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-campaignResponses-imports-{id}-put",
"x-filename-id":"api-bulk-2.0-campaignresponses-imports-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/campaignResponses"
],
"summary":"Delete a campaign response import definition",
"description":"Deletes a campaign response import definition. See Using the campaign response endpoints in the Oracle Eloqua Developer Help Center for more complete information about these endpoints.",
"operationId":"DeleteCampaignResponseImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"This property is not used.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-campaignResponses-imports-{id}-delete",
"x-filename-id":"api-bulk-2.0-campaignresponses-imports-id-delete"
}
},
"/api/bulk/2.0/campaignResponses/imports/{id}/data":{
"post":{
"tags":[
"Bulk/2.0/campaignResponses"
],
"summary":"Upload data for a campaign response import definition",
"description":"Uploads data for a campaign response import definition. See Using the campaign response endpoints in the Oracle Eloqua Developer Help Center for more complete information about these endpoints.",
"operationId":"PostCampaignResponseImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"This property is not used.",
"required":true,
"type":"integer"
},
{
"name":"CampaignResponseImportData",
"in":"body",
"description":"The request body contains details of the campaign response data.",
"required":true,
"schema":{
"title":"CampaignResponseImportData",
"type":"array",
"items":{
"title":"CampaignResponseImportDataItem",
"type":"object",
"items":{
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"OK.",
"schema":{
"title":"CampaignResponseImportDataResponse",
"description":"Sync response when POSTing campaign response sync action data, and isSyncTriggeredOnImport = true on the sync action definition.",
"properties":{
"callbackUrl":{
"title":"callbackUrl",
"description":"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.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"status":{
"$ref":"#/definitions/SyncStatusType"
},
"syncedInstanceUri":{
"title":"syncedInstanceUri",
"description":"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.",
"type":"string"
},
"syncEndedAt":{
"format":"date-time",
"title":"syncEndedAt",
"description":"The date and time the sync ended. This is a read-only property.",
"type":"string"
},
"syncStartedAt":{
"format":"date-time",
"title":"syncStartedAt",
"description":"The date and time the sync started. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"204":{
"description":"No content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-campaignResponses-imports-{id}-data-post",
"x-filename-id":"api-bulk-2.0-campaignresponses-imports-id-data-post"
},
"delete":{
"tags":[
"Bulk/2.0/campaignResponses"
],
"summary":"Delete the synced data for a campaign response import definition",
"description":"Deletes the synced data for a campaign response import definition. See Using the campaign response endpoints in the Oracle Eloqua Developer Help Center for more complete information about these endpoints.",
"operationId":"DeleteCampaignResponseImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"This property is not used.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-campaignResponses-imports-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-campaignresponses-imports-id-data-delete"
}
},
"/api/rest/2.0/assets/contact/filter/folder":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the folder to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest20"
}
}
],
"summary":"Create a folder",
"description":"Creates a folder that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact filter folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-filter-folder-post",
"x-filename-id":"api-rest-2.0-assets-contact-filter-folder-post"
}
},
"/api/rest/2.0/assets/contact/filter/folder/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"string"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"extensions",
"in":"query",
"description":"IFilterFolderService_Parameter_ReadIndividual_extensions_Description",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a folder",
"description":"Retrieves the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact filter folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-filter-folder-{id}-get",
"x-filename-id":"api-rest-2.0-assets-contact-filter-folder-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the folder to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"string"
}
],
"summary":"Update a folder",
"description":"The request body defines the details of the folder to be updated.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact filter folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-filter-folder-{id}-put",
"x-filename-id":"api-rest-2.0-assets-contact-filter-folder-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"string"
}
],
"summary":"Delete a folder",
"description":"Deletes the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact filter folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-filter-folder-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-contact-filter-folder-id-delete"
}
},
"/api/rest/2.0/assets/contact/filter/folders":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"string"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"string"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"string"
},
{
"name":"extensions",
"in":"query",
"description":"IFilterFolderService_Parameter_Search_extensions_Description",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a list of folders",
"description":"Retrieves all folders that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact filter folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-filter-folders-get",
"x-filename-id":"api-rest-2.0-assets-contact-filter-folders-get"
}
},
"/api/rest/2.0/assets/contact/filter/folder/{id}/contents":{
"get":{
"operationId":"SearchContentsGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"string"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"string"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"string"
},
{
"name":"extensions",
"in":"query",
"description":"IFilterFolderService_Parameter_SearchContents_extensions_Description",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a list of folder contents",
"description":"Retrieves all folder contents that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContractObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact filter folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-filter-folder-{id}-contents-get",
"x-filename-id":"api-rest-2.0-assets-contact-filter-folder-id-contents-get"
},
"patch":{
"operationId":"BatchMovePATCHRest20",
"parameters":[
{
"name":"contents",
"in":"body",
"description":"The contents to place in the folder.",
"required":true,
"items":{
"$ref":"#/definitions/MinimalRest20"
},
"schema":{
"type":"array"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"string"
}
],
"summary":"Add content to a folder",
"description":"Places all content into the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/MinimalRest20"
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact filter folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-filter-folder-{id}-contents-patch",
"x-filename-id":"api-rest-2.0-assets-contact-filter-folder-id-contents-patch"
}
},
"/api/rest/2.0/assets/contact/filter/folder/root/contents":{
"get":{
"operationId":"SearchRootContentsGETRest20",
"parameters":[
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"string"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"string"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"string"
},
{
"name":"extensions",
"in":"query",
"description":"IFilterFolderService_Parameter_SearchRootContents_extensions_Description",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a list of folder contents in the root folder",
"description":"Retrieves all folder contents in the root folder that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContractObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact filter folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-filter-folder-root-contents-get",
"x-filename-id":"api-rest-2.0-assets-contact-filter-folder-root-contents-get"
}
},
"/api/rest/2.0/assets/contact/filter/folder/root":{
"get":{
"operationId":"ReadRootFolderGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"extensions",
"in":"query",
"description":"IFilterFolderService_Parameter_ReadRootFolder_extensions_Description",
"required":false,
"type":"string"
}
],
"summary":"Retrieve the root folder",
"description":"Retrieves the root folder.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact filter folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-filter-folder-root-get",
"x-filename-id":"api-rest-2.0-assets-contact-filter-folder-root-get"
}
},
"/api/rest/1.0/assets/contact/list":{
"post":{
"operationId":"CreateIndividualPOSTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the contact list to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/ContactListRest10"
}
}
],
"summary":"Create a contact list",
"description":"Creates a contact list that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/ContactListRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contact list"
],
"x-internal-id":"api-rest-1.0-assets-contact-list-post",
"x-filename-id":"api-rest-1.0-assets-contact-list-post"
}
},
"/api/rest/1.0/assets/contact/list/{id}":{
"get":{
"operationId":"ReadIndividualGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the contact list.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a contact list",
"description":"Retrieves the contact list specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/ContactListRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contact list"
],
"x-internal-id":"api-rest-1.0-assets-contact-list-{id}-get",
"x-filename-id":"api-rest-1.0-assets-contact-list-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the contact list to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/ContactListRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the contact list.",
"required":true,
"type":"integer"
}
],
"summary":"Update a contact list",
"description":"Updates the contact list specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/ContactListRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contact list"
],
"x-internal-id":"api-rest-1.0-assets-contact-list-{id}-put",
"x-filename-id":"api-rest-1.0-assets-contact-list-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the contact list.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a contact list",
"description":"Deletes the contact list specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contact list"
],
"x-internal-id":"api-rest-1.0-assets-contact-list-{id}-delete",
"x-filename-id":"api-rest-1.0-assets-contact-list-id-delete"
}
},
"/api/rest/1.0/assets/contact/lists":{
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"Unix timestamp for the date and time the contact list was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of contact lists",
"description":"Retrieves all contact lists that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultListRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contact list"
],
"x-internal-id":"api-rest-1.0-assets-contact-lists-get",
"x-filename-id":"api-rest-1.0-assets-contact-lists-get"
}
},
"/API/OData/LandingPageAnalysis/1/Calendar":{
"get":{
"tags":[
"Reporting/LandingPageAnalysis/1.0/Calendar"
],
"summary":"Get all Calendars",
"operationId":"Calendar_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Calendars successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Calendar"
}
}
}
},
"x-internal-id":"API-OData-LandingPageAnalysis-1-Calendar-get",
"x-filename-id":"api-odata-landingpageanalysis-1-calendar-get"
}
},
"/API/OData/LandingPageAnalysis/1/LandingPageActivity":{
"get":{
"tags":[
"Reporting/LandingPageAnalysis/1.0/LandingPageActivity"
],
"summary":"Get all Landing Page Activities",
"operationId":"LandingPageActivity_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"LandingPageActivity successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/LandingPageActivity"
}
}
}
},
"x-internal-id":"API-OData-LandingPageAnalysis-1-LandingPageActivity-get",
"x-filename-id":"api-odata-landingpageanalysis-1-landingpageactivity-get"
}
},
"/API/OData/LandingPageAnalysis/1/LandingPageAsset":{
"get":{
"tags":[
"Reporting/LandingPageAnalysis/1.0/LandingPageAsset"
],
"summary":"Get all Landing Page Assets",
"operationId":"LandingPageAsset_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"LandingPageAssets successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/LandingPageAsset"
}
}
}
},
"x-internal-id":"API-OData-LandingPageAnalysis-1-LandingPageAsset-get",
"x-filename-id":"api-odata-landingpageanalysis-1-landingpageasset-get"
}
},
"/API/OData/LandingPageAnalysis/1/LandingPageAsset/{key}":{
"get":{
"tags":[
"Reporting/LandingPageAnalysis/1.0/LandingPageAsset"
],
"summary":"Get a single Landing Page Asset",
"operationId":"LandingPageAsset_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"The requested LandingPageAssets identifier",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"LandingPageAssets was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/LandingPageAsset"
}
}
}
},
"x-internal-id":"API-OData-LandingPageAnalysis-1-LandingPageAsset-{key}-get",
"x-filename-id":"api-odata-landingpageanalysis-1-landingpageasset-key-get"
}
},
"/api/rest/2.0/assets/campaign/folder":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the folder to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest20"
}
}
],
"summary":"Create a folder",
"description":"Creates a folder that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaign folders"
],
"x-internal-id":"api-rest-2.0-assets-campaign-folder-post",
"x-filename-id":"api-rest-2.0-assets-campaign-folder-post"
}
},
"/api/rest/2.0/assets/campaign/folder/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a folder",
"description":"Retrieves the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaign folders"
],
"x-internal-id":"api-rest-2.0-assets-campaign-folder-{id}-get",
"x-filename-id":"api-rest-2.0-assets-campaign-folder-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the folder to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
}
],
"summary":"Update a folder",
"description":"The request body defines the details of the folder to be updated.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaign folders"
],
"x-internal-id":"api-rest-2.0-assets-campaign-folder-{id}-put",
"x-filename-id":"api-rest-2.0-assets-campaign-folder-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a folder",
"description":"Deletes the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaign folders"
],
"x-internal-id":"api-rest-2.0-assets-campaign-folder-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-campaign-folder-id-delete"
}
},
"/api/rest/2.0/assets/campaign/folders":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of folders",
"description":"Retrieves all folders that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaign folders"
],
"x-internal-id":"api-rest-2.0-assets-campaign-folders-get",
"x-filename-id":"api-rest-2.0-assets-campaign-folders-get"
}
},
"/api/rest/2.0/assets/campaign/folder/{id}/contents":{
"get":{
"operationId":"SearchContentsGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of folder contents",
"description":"Retrieves all folder contents that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContractObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaign folders"
],
"x-internal-id":"api-rest-2.0-assets-campaign-folder-{id}-contents-get",
"x-filename-id":"api-rest-2.0-assets-campaign-folder-id-contents-get"
},
"patch":{
"operationId":"BatchMovePATCHRest20",
"parameters":[
{
"name":"contents",
"in":"body",
"description":"The contents to place in the folder.",
"required":true,
"items":{
"$ref":"#/definitions/MinimalRest20"
},
"schema":{
"type":"array"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
}
],
"summary":"Add content to a folder",
"description":"Places all content into the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/MinimalRest20"
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaign folders"
],
"x-internal-id":"api-rest-2.0-assets-campaign-folder-{id}-contents-patch",
"x-filename-id":"api-rest-2.0-assets-campaign-folder-id-contents-patch"
}
},
"/api/rest/2.0/assets/campaign/folder/root/contents":{
"get":{
"operationId":"SearchRootContentsGETRest20",
"parameters":[
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of folder contents in the root folder",
"description":"Retrieves all folder contents in the root folder that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContractObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaign folders"
],
"x-internal-id":"api-rest-2.0-assets-campaign-folder-root-contents-get",
"x-filename-id":"api-rest-2.0-assets-campaign-folder-root-contents-get"
}
},
"/api/rest/2.0/assets/campaign/folder/root":{
"get":{
"operationId":"ReadRootFolderGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve the root folder",
"description":"Retrieves the root folder.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaign folders"
],
"x-internal-id":"api-rest-2.0-assets-campaign-folder-root-get",
"x-filename-id":"api-rest-2.0-assets-campaign-folder-root-get"
}
},
"/api/rest/2.0/assets/campaign/folder/root/folders":{
"get":{
"operationId":"SearchRootSubFoldersGETRest20",
"parameters":[
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of subfolders in the root folder",
"description":"Retrieves all subfolders in the root folder that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaign folders"
],
"x-internal-id":"api-rest-2.0-assets-campaign-folder-root-folders-get",
"x-filename-id":"api-rest-2.0-assets-campaign-folder-root-folders-get"
}
},
"/api/rest/2.0/assets/campaign/folder/{id}/folders":{
"get":{
"operationId":"SearchSubFoldersGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of subfolders",
"description":"Retrieves all subfolders that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaign folders"
],
"x-internal-id":"api-rest-2.0-assets-campaign-folder-{id}-folders-get",
"x-filename-id":"api-rest-2.0-assets-campaign-folder-id-folders-get"
}
},
"/api/rest/1.0/assets/contact/field/{id}":{
"get":{
"operationId":"ReadIndividualGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the contact field to be retrieved.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a contact field",
"description":"Retrieves the contact field specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/ContactFieldRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contact fields"
],
"x-internal-id":"api-rest-1.0-assets-contact-field-{id}-get",
"x-filename-id":"api-rest-1.0-assets-contact-field-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"List of contact fields.",
"required":true,
"schema":{
"$ref":"#/definitions/ContactFieldRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the contact field to be updated.",
"required":true,
"type":"integer"
}
],
"summary":"Update a contact field",
"description":"Updates the contact field specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/ContactFieldRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contact fields"
],
"x-internal-id":"api-rest-1.0-assets-contact-field-{id}-put",
"x-filename-id":"api-rest-1.0-assets-contact-field-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the contact field to delete.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a contact field",
"description":"Deletes the contact field specified by the id parameter.",
"responses":{
"204":{
"description":"No matching contact fields were found in the search."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"The contact field you are attempting to delete has dependencies, and cannot be deleted."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contact fields"
],
"x-internal-id":"api-rest-1.0-assets-contact-field-{id}-delete",
"x-filename-id":"api-rest-1.0-assets-contact-field-id-delete"
}
},
"/api/rest/1.0/assets/contact/field":{
"post":{
"operationId":"CreateIndividualPOSTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the contact field to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/ContactFieldRest10"
}
}
],
"summary":"Create a contact field",
"description":"Creates a contact field that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/ContactFieldRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contact fields"
],
"x-internal-id":"api-rest-1.0-assets-contact-field-post",
"x-filename-id":"api-rest-1.0-assets-contact-field-post"
}
},
"/api/rest/1.0/assets/contact/fields":{
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"Unix timestamp for the date and time the contact field was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of contact fields",
"description":"Retrieves all contact field that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContactFieldRest10"
}
},
"204":{
"description":"No matching contact fields were found in the search"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contact fields"
],
"x-internal-id":"api-rest-1.0-assets-contact-fields-get",
"x-filename-id":"api-rest-1.0-assets-contact-fields-get"
}
},
"/api/rest/2.0/assets/sms":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of an sms to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/SmsRest20"
}
}
],
"summary":"Create an SMS",
"description":"Creates an SMS that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/SmsRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS"
],
"x-internal-id":"api-rest-2.0-assets-sms-post",
"x-filename-id":"api-rest-2.0-assets-sms-post"
},
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time an sms was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of SMS",
"description":"Retrieves all SMS that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultSmsRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS"
],
"x-internal-id":"api-rest-2.0-assets-sms-get",
"x-filename-id":"api-rest-2.0-assets-sms-get"
}
},
"/api/rest/2.0/assets/sms/{id}":{
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of an sms to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/SmsRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of an sms.",
"required":true,
"type":"string"
}
],
"summary":"Update an SMS",
"description":"Updates the SMS specified by the id.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/SmsRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS"
],
"x-internal-id":"api-rest-2.0-assets-sms-{id}-put",
"x-filename-id":"api-rest-2.0-assets-sms-id-put"
},
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of an sms.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve an SMS",
"description":"Retrieves the SMS specified by the id.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/SmsRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS"
],
"x-internal-id":"api-rest-2.0-assets-sms-{id}-get",
"x-filename-id":"api-rest-2.0-assets-sms-id-get"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of an sms to be deleted.",
"required":true,
"type":"integer"
}
],
"summary":"Delete an SMS",
"description":"Deletes the SMS specified by the id.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS"
],
"x-internal-id":"api-rest-2.0-assets-sms-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-sms-id-delete"
}
},
"/api/rest/2.0/system/user":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the user to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/UserRest20"
}
}
],
"summary":"Create a user",
"description":"Creates a new user.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/UserRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"Conflict"
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Users"
],
"x-internal-id":"api-rest-2.0-system-user-post",
"x-filename-id":"api-rest-2.0-system-user-post"
}
},
"/api/rest/2.0/system/user/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"The user ID to retrieve",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a user",
"description":"Retrieves the user specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/UserRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Users"
],
"x-internal-id":"api-rest-2.0-system-user-{id}-get",
"x-filename-id":"api-rest-2.0-system-user-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the user to be updated",
"required":true,
"schema":{
"$ref":"#/definitions/UserRest20"
}
},
{
"name":"id",
"in":"path",
"description":"The ID of the user to update",
"required":true,
"type":"integer"
}
],
"summary":"Update a user",
"description":"Updates the user specified by the id parameter. Users without the \"ManageUsers\" action permission can only update their own user account.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/UserRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Users"
],
"x-internal-id":"api-rest-2.0-system-user-{id}-put",
"x-filename-id":"api-rest-2.0-system-user-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"The user ID to delete",
"required":true,
"type":"integer"
}
],
"summary":"Delete a user",
"description":"Deletes a user",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Users"
],
"x-internal-id":"api-rest-2.0-system-user-{id}-delete",
"x-filename-id":"api-rest-2.0-system-user-id-delete"
}
},
"/api/rest/2.0/system/user/current":{
"get":{
"operationId":"GetCurrentUserGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve the current user",
"description":"Retrieves the current user performing the request.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/UserRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Users"
],
"x-internal-id":"api-rest-2.0-system-user-current-get",
"x-filename-id":"api-rest-2.0-system-user-current-get"
}
},
"/api/rest/2.0/system/user/{id}/password":{
"put":{
"operationId":"UpdatePasswordPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the request",
"required":true,
"schema":{
"$ref":"#/definitions/UserPasswordRest20"
}
},
{
"name":"id",
"in":"path",
"description":"The id of the user to update the password",
"required":true,
"type":"integer"
}
],
"summary":"Update a user's password",
"description":"Updates a user's password.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Users"
],
"x-internal-id":"api-rest-2.0-system-user-{id}-password-put",
"x-filename-id":"api-rest-2.0-system-user-id-password-put"
}
},
"/api/rest/2.0/system/user/{id}/enabled":{
"put":{
"operationId":"UpdateEnabledPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines whether to enable or disable the user with the specified ID",
"required":true,
"schema":{
"$ref":"#/definitions/UserEnabledRest20"
}
},
{
"name":"id",
"in":"path",
"description":"The ID of the user to enable or disable",
"required":true,
"type":"integer"
}
],
"summary":"Enable or disable a user",
"description":"Enables or disables the user's account specified by the id parameter. Users without the \"ManageUsers\" action permission can only enable or disable their own account.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/UserEnabledRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Users"
],
"x-internal-id":"api-rest-2.0-system-user-{id}-enabled-put",
"x-filename-id":"api-rest-2.0-system-user-id-enabled-put"
}
},
"/api/rest/2.0/system/users":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. The default value is minimal.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the user was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of users",
"description":"Retrieves all users that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultUserRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Users"
],
"x-internal-id":"api-rest-2.0-system-users-get",
"x-filename-id":"api-rest-2.0-system-users-get"
}
},
"/api/rest/2.0/data/activity":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the external activity to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/ExternalActivitiesRest20"
}
}
],
"summary":"Create an external activity",
"description":"Creates an external activity that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/ExternalActivitiesRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/External activities"
],
"x-internal-id":"api-rest-2.0-data-activity-post",
"x-filename-id":"api-rest-2.0-data-activity-post"
}
},
"/api/rest/2.0/data/activity/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the external activity to retrieve.",
"required":true,
"type":"integer"
}
],
"summary":"Retrieve an external activity",
"description":"Retrieves the external activity data specified by the id parameter. Ids are not consecutive.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/ExternalActivitiesRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/External activities"
],
"x-internal-id":"api-rest-2.0-data-activity-{id}-get",
"x-filename-id":"api-rest-2.0-data-activity-id-get"
}
},
"/api/rest/1.0/system/user/{id}":{
"get":{
"operationId":"ReadIndividualGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the user to retrieve.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a user",
"description":"Retrieves the user specified by the id parameter. For security purposes, full user details are only displayed in a response if the user profile being retrieved via the API is the same user performing the request.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/UserRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Users"
],
"x-internal-id":"api-rest-1.0-system-user-{id}-get",
"x-filename-id":"api-rest-1.0-system-user-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the user to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/UserRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the user to update.",
"required":true,
"type":"integer"
}
],
"summary":"Update a user",
"description":"Updates the user specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/UserRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Users"
],
"x-internal-id":"api-rest-1.0-system-user-{id}-put",
"x-filename-id":"api-rest-1.0-system-user-id-put"
}
},
"/api/rest/1.0/system/users":{
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the user was last updated. This is a read-only property.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of users",
"description":"Retrieves all users that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultUserRest10"
}
},
"204":{
"description":"No matching users were found in the search."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Users"
],
"x-internal-id":"api-rest-1.0-system-users-get",
"x-filename-id":"api-rest-1.0-system-users-get"
}
},
"/api/rest/2.0/assets/sms/folder":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the folder to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest20"
}
}
],
"summary":"Create a folder",
"description":"Creates a folder that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS folders"
],
"x-internal-id":"api-rest-2.0-assets-sms-folder-post",
"x-filename-id":"api-rest-2.0-assets-sms-folder-post"
}
},
"/api/rest/2.0/assets/sms/folder/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a folder",
"description":"Retrieves the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS folders"
],
"x-internal-id":"api-rest-2.0-assets-sms-folder-{id}-get",
"x-filename-id":"api-rest-2.0-assets-sms-folder-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the folder to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the folder",
"required":true,
"type":"string"
}
],
"summary":"Update a folder",
"description":"The request body defines the details of the folder to be updated.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS folders"
],
"x-internal-id":"api-rest-2.0-assets-sms-folder-{id}-put",
"x-filename-id":"api-rest-2.0-assets-sms-folder-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder",
"required":true,
"type":"integer"
}
],
"summary":"Delete a folder",
"description":"Deletes the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS folders"
],
"x-internal-id":"api-rest-2.0-assets-sms-folder-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-sms-folder-id-delete"
}
},
"/api/rest/2.0/assets/sms/folder/{id}/contents":{
"patch":{
"operationId":"BatchMovePATCHRest20",
"parameters":[
{
"name":"contents",
"in":"body",
"description":"The contents to place in the folder.",
"required":true,
"items":{
"$ref":"#/definitions/MinimalRest20"
},
"schema":{
"type":"array"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
}
],
"summary":"Add content to a folder",
"description":"Places all content into the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/MinimalRest20"
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS folders"
],
"x-internal-id":"api-rest-2.0-assets-sms-folder-{id}-contents-patch",
"x-filename-id":"api-rest-2.0-assets-sms-folder-id-contents-patch"
},
"get":{
"operationId":"SearchContentsGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the folder was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of folder contents",
"description":"Retrieves all folder contents that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContractObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS folders"
],
"x-internal-id":"api-rest-2.0-assets-sms-folder-{id}-contents-get",
"x-filename-id":"api-rest-2.0-assets-sms-folder-id-contents-get"
}
},
"/api/rest/2.0/assets/sms/folder/root":{
"get":{
"operationId":"ReadRootFolderGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve the root folder",
"description":"Retrieves the root folder.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS folders"
],
"x-internal-id":"api-rest-2.0-assets-sms-folder-root-get",
"x-filename-id":"api-rest-2.0-assets-sms-folder-root-get"
}
},
"/api/rest/2.0/assets/sms/folder/root/contents":{
"get":{
"operationId":"SearchRootContentsGETRest20",
"parameters":[
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the folder was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of folder contents in the root folder",
"description":"Retrieves all folder contents in the root folder that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContractObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS folders"
],
"x-internal-id":"api-rest-2.0-assets-sms-folder-root-contents-get",
"x-filename-id":"api-rest-2.0-assets-sms-folder-root-contents-get"
}
},
"/api/rest/2.0/assets/sms/folder/root/folders":{
"get":{
"operationId":"SearchRootSubFoldersGETRest20",
"parameters":[
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the folder was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of subfolders in the root folder",
"description":"Retrieves all subfolders in the root folder that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS folders"
],
"x-internal-id":"api-rest-2.0-assets-sms-folder-root-folders-get",
"x-filename-id":"api-rest-2.0-assets-sms-folder-root-folders-get"
}
},
"/api/rest/2.0/assets/sms/folder/{id}/folders":{
"get":{
"operationId":"SearchSubFoldersGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the folder was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of subfolders",
"description":"Retrieves all subfolders that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS folders"
],
"x-internal-id":"api-rest-2.0-assets-sms-folder-{id}-folders-get",
"x-filename-id":"api-rest-2.0-assets-sms-folder-id-folders-get"
}
},
"/api/rest/2.0/assets/sms/folders":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"ISmsFolderService_Parameter_Search_depth_Description",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"ISmsFolderService_Parameter_Search_count_Description",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"ISmsFolderService_Parameter_Search_page_Description",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"ISmsFolderService_Parameter_Search_search_Description",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"ISmsFolderService_Parameter_Search_orderBy_Description",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"ISmsFolderService_Parameter_Search_lastUpdatedAt_Description",
"required":false,
"type":"integer"
},
{
"name":"includeAvailable",
"in":"query",
"description":"ISmsFolderService_Parameter_Search_includeAvailable_Description",
"required":false,
"type":"boolean"
},
{
"name":"includeArchived",
"in":"query",
"description":"ISmsFolderService_Parameter_Search_includeArchived_Description",
"required":false,
"type":"boolean"
}
],
"summary":"Retrieve a list of folders",
"description":"Retrieves all folders that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"ISmsFolderService_StatusCode_Search_200_Description",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS folders"
],
"x-internal-id":"api-rest-2.0-assets-sms-folders-get",
"x-filename-id":"api-rest-2.0-assets-sms-folders-get"
}
},
"/api/rest/2.0/assets/account/group":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the account group to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/AccountGroupRest20"
}
}
],
"summary":"Create an account group",
"description":"Creates an account group that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/AccountGroupRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Account groups"
],
"x-internal-id":"api-rest-2.0-assets-account-group-post",
"x-filename-id":"api-rest-2.0-assets-account-group-post"
}
},
"/api/rest/2.0/assets/account/group/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the account group.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve an account group",
"description":"Retrieves the account group specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/AccountGroupRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Account groups"
],
"x-internal-id":"api-rest-2.0-assets-account-group-{id}-get",
"x-filename-id":"api-rest-2.0-assets-account-group-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the account group to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/AccountGroupRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the account group.",
"required":true,
"type":"integer"
}
],
"summary":"Update an account group",
"description":"Updates the account group specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/AccountGroupRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Account groups"
],
"x-internal-id":"api-rest-2.0-assets-account-group-{id}-put",
"x-filename-id":"api-rest-2.0-assets-account-group-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the account group.",
"required":true,
"type":"integer"
}
],
"summary":"Delete an account group",
"description":"Deletes the account group specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Account groups"
],
"x-internal-id":"api-rest-2.0-assets-account-group-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-account-group-id-delete"
}
},
"/api/rest/2.0/assets/account/groups":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which account group results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"Unix timestamp for the date and time the account group was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of account groups",
"description":"Retrieves all account groups that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultAccountGroupRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Account groups"
],
"x-internal-id":"api-rest-2.0-assets-account-groups-get",
"x-filename-id":"api-rest-2.0-assets-account-groups-get"
}
},
"/api/rest/2.0/assets/email/signature/rule/{ruleId}/mappings":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"ruleId",
"in":"path",
"description":"Id of the signature rule to target.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered, and the direction. The direction will default to ASC if not specified. See the URL parameters for information.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"Unix timestamp for the date and time the external asset was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of signature rule mappings",
"description":"Retrieves all signature rule mappings for the signature rule specified by the id parameter that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultRuleMappingRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Signature Rule Mappings"
],
"x-internal-id":"api-rest-2.0-assets-email-signature-rule-{ruleId}-mappings-get",
"x-filename-id":"api-rest-2.0-assets-email-signature-rule-ruleid-mappings-get"
},
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"ruleId",
"in":"path",
"description":"Id of the signature rule to target.",
"required":true,
"type":"integer"
},
{
"name":"ruleMappings",
"in":"body",
"description":"The request body defines the details of the signature rule mappings to be created.",
"required":true,
"items":{
"$ref":"#/definitions/EmailSignatureRuleMappingRest20"
},
"schema":{
"type":"array"
}
}
],
"summary":"Create signature rule mappings",
"description":"Create signature rule mappings for the signature rule specified by the id parameter.\r\nA maximum of 75000 mappings can be provided.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailSignatureRuleMappingRest20"
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Signature Rule Mappings"
],
"x-internal-id":"api-rest-2.0-assets-email-signature-rule-{ruleId}-mappings-post",
"x-filename-id":"api-rest-2.0-assets-email-signature-rule-ruleid-mappings-post"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"ruleId",
"in":"path",
"description":"Id of the signature rule to update.",
"required":true,
"type":"integer"
},
{
"name":"ruleMappings",
"in":"body",
"description":"The request body defines the details of the signature rule mappings to be updated.",
"required":true,
"items":{
"$ref":"#/definitions/EmailSignatureRuleMappingRest20"
},
"schema":{
"type":"array"
}
}
],
"summary":"Update signature rule mappings",
"description":"Update signature rule mappings for the signature rule specified by the id parameter.\r\nAll mappings should be included in PUT requests as any missing mappings will be removed with the update.\r\nA maximum of 75000 mappings can be provided.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailSignatureRuleMappingRest20"
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Signature Rule Mappings"
],
"x-internal-id":"api-rest-2.0-assets-email-signature-rule-{ruleId}-mappings-put",
"x-filename-id":"api-rest-2.0-assets-email-signature-rule-ruleid-mappings-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"ruleId",
"in":"path",
"description":"Id of the signature rule to delete mappings from.",
"required":true,
"type":"integer"
}
],
"summary":"Delete signature rule mappings",
"description":"Delete signature rule mappings for the signature rule specified by the id parameter.",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Signature Rule Mappings"
],
"x-internal-id":"api-rest-2.0-assets-email-signature-rule-{ruleId}-mappings-delete",
"x-filename-id":"api-rest-2.0-assets-email-signature-rule-ruleid-mappings-delete"
}
},
"/api/rest/2.0/assets/contact/segment":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the contact segment to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/ContactSegmentRest20"
}
}
],
"summary":"Create a contact segment",
"description":"Creates a contact segment that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/ContactSegmentRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact segments"
],
"x-internal-id":"api-rest-2.0-assets-contact-segment-post",
"x-filename-id":"api-rest-2.0-assets-contact-segment-post"
}
},
"/api/rest/2.0/assets/contact/segment/{id}/copy":{
"post":{
"operationId":"CreateCopyPOSTRest20",
"parameters":[
{
"name":"template",
"in":"body",
"description":"The request body defines the details of the contact segment to be created from the source contact segment.",
"required":true,
"schema":{
"$ref":"#/definitions/ContactSegmentRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the segment to copy.",
"required":true,
"type":"integer"
}
],
"summary":"Create a copy of a contact segment",
"description":"Creates a copy of a contact segment that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Created",
"schema":{
"$ref":"#/definitions/ContactSegmentRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact segments"
],
"x-internal-id":"api-rest-2.0-assets-contact-segment-{id}-copy-post",
"x-filename-id":"api-rest-2.0-assets-contact-segment-id-copy-post"
}
},
"/api/rest/2.0/assets/contact/segment/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the contact segment.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a contact segment",
"description":"Retrieves the contact segment specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/ContactSegmentRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact segments"
],
"x-internal-id":"api-rest-2.0-assets-contact-segment-{id}-get",
"x-filename-id":"api-rest-2.0-assets-contact-segment-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the contact segment to be update.",
"required":true,
"schema":{
"$ref":"#/definitions/ContactSegmentRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the contact segment.",
"required":true,
"type":"integer"
}
],
"summary":"Update a contact segment",
"description":"Updates the contact segment specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/ContactSegmentRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact segments"
],
"x-internal-id":"api-rest-2.0-assets-contact-segment-{id}-put",
"x-filename-id":"api-rest-2.0-assets-contact-segment-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the contact segment.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a contact segment",
"description":"Deletes the contact segment specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact segments"
],
"x-internal-id":"api-rest-2.0-assets-contact-segment-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-contact-segment-id-delete"
}
},
"/api/rest/2.0/assets/contact/segments":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"Unix timestamp for the date and time the contact segment was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of contact segments",
"description":"Retrieves all contact segments that match the criteria specified by the request parameters",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultSegmentRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact segments"
],
"x-internal-id":"api-rest-2.0-assets-contact-segments-get",
"x-filename-id":"api-rest-2.0-assets-contact-segments-get"
}
},
"/api/rest/1.0/data/contact":{
"post":{
"operationId":"CreateIndividualPOSTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the contact to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/ContactRest10"
}
}
],
"summary":"Create a contact",
"description":"Creates a contact that matches the criteria specified by the request body",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/ContactRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contacts"
],
"x-internal-id":"api-rest-1.0-data-contact-post",
"x-filename-id":"api-rest-1.0-data-contact-post"
}
},
"/api/rest/1.0/data/contact/{id}":{
"get":{
"operationId":"ReadIndividualGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the contact.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
},
{
"name":"viewId",
"in":"query",
"description":"Id of the contact view.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a contact",
"description":"Retrieves the contact specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/ContactRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contacts"
],
"x-internal-id":"api-rest-1.0-data-contact-{id}-get",
"x-filename-id":"api-rest-1.0-data-contact-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the contact to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/ContactRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the contact.",
"required":true,
"type":"integer"
}
],
"summary":"Update a contact",
"description":"Updates the contact specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/ContactRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contacts"
],
"x-internal-id":"api-rest-1.0-data-contact-{id}-put",
"x-filename-id":"api-rest-1.0-data-contact-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the contact",
"required":true,
"type":"integer"
}
],
"summary":"Delete a contact",
"description":"Deletes a contact specified by the id parameter",
"responses":{
"204":{
"description":"No matching contacts were found in the search"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"The contact you are attempting to delete has dependencies, and cannot be deleted"
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contacts"
],
"x-internal-id":"api-rest-1.0-data-contact-{id}-delete",
"x-filename-id":"api-rest-1.0-data-contact-id-delete"
}
},
"/api/rest/1.0/data/contacts":{
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"Unix timestamp for the date and time the contact was last updated. This is a read-only property.",
"required":false,
"type":"integer"
},
{
"name":"viewId",
"in":"query",
"description":"Id of the contact view to filter results. Must be a valid contact view id. Example: ?viewId=100006.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of contacts",
"description":"Retrieves all contacts that match the criteria specified by the request parameters",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContactRest10"
}
},
"204":{
"description":"No matching contacts were found in the search"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contacts"
],
"x-internal-id":"api-rest-1.0-data-contacts-get",
"x-filename-id":"api-rest-1.0-data-contacts-get"
}
},
"/api/rest/1.0/data/customObject/{id}":{
"post":{
"operationId":"CreateIndividualPOSTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the custom object data to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/CustomObjectDataRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the custom object.",
"required":true,
"type":"integer"
}
],
"summary":"Create custom object data",
"description":"Creates custom object data that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/CustomObjectDataRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Custom object data"
],
"x-internal-id":"api-rest-1.0-data-customObject-{id}-post",
"x-filename-id":"api-rest-1.0-data-customobject-id-post"
},
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the custom object.",
"required":true,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"Unix timestamp for the date and time the custom object was last updated. This is a read-only property.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of custom object data",
"description":"Retrieves the data for the custom object specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultCustomObjectDataRest10"
}
},
"204":{
"description":"No matching custom objects were found in the search."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Custom object data"
],
"x-internal-id":"api-rest-1.0-data-customObject-{id}-get",
"x-filename-id":"api-rest-1.0-data-customobject-id-get"
}
},
"/api/bulk/2.0/exports/data":{
"get":{
"tags":[
"Bulk/2.0/exports"
],
"summary":"Discover the amount of database space your exports are using",
"description":"This endpoint is used to discover how much space current exports are taking up in your database.",
"operationId":"GetExportStorage",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ExportStorageResponse",
"description":"Response for the export storage usage, filtered by the fields or fieldsUri.",
"properties":{
"kbAllowed":{
"format":"int64",
"title":"kbAllowed",
"description":"This value is set to \"0\" on purpose, this means there is no limit.",
"type":"integer"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space currently taking up in your database.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-exports-data-get",
"x-filename-id":"api-bulk-2.0-exports-data-get"
}
},
"/api/bulk/2.0/exports":{
"get":{
"tags":[
"Bulk/2.0/exports"
],
"summary":"Retrieve a list of exports",
"description":"Retrieves a list of exports.",
"operationId":"GetExportSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ExportSearchResponse",
"description":"The response body contains information about the export definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"List of export definitions.",
"type":"array",
"items":{
"$ref":"#/definitions/Export"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-exports-get",
"x-filename-id":"api-bulk-2.0-exports-get"
}
},
"/api/rest/2.0/assets/sms/keywords":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the Keyword was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of keywords",
"description":"Retrieves all Keyword that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultKeywordRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS keywords"
],
"x-internal-id":"api-rest-2.0-assets-sms-keywords-get",
"x-filename-id":"api-rest-2.0-assets-sms-keywords-get"
}
},
"/api/rest/2.0/assets/sms/keyword/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the Keyword",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a keyword",
"description":"Retrieves the Keyword specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/KeywordRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS keywords"
],
"x-internal-id":"api-rest-2.0-assets-sms-keyword-{id}-get",
"x-filename-id":"api-rest-2.0-assets-sms-keyword-id-get"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the Keyword",
"required":true,
"type":"integer"
}
],
"summary":"Delete a keyword",
"description":"Deletes the Keyword specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS keywords"
],
"x-internal-id":"api-rest-2.0-assets-sms-keyword-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-sms-keyword-id-delete"
}
},
"/api/rest/2.0/assets/sms/keyword":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the Keyword to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/KeywordRest20"
}
}
],
"summary":"Create a Keyword",
"description":"Creates a Keyword that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/KeywordRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS keywords"
],
"x-internal-id":"api-rest-2.0-assets-sms-keyword-post",
"x-filename-id":"api-rest-2.0-assets-sms-keyword-post"
}
},
"/API/OData/CampaignExternalActivity/1/ExternalActivities":{
"get":{
"tags":[
"Reporting/CampaignExternalActivity/1.0/ExternalActivities"
],
"summary":"Get all External Activities",
"operationId":"ExternalActivities_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"ExternalActivities successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/ExternalActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignExternalActivity-1-ExternalActivities-get",
"x-filename-id":"api-odata-campaignexternalactivity-1-externalactivities-get"
}
},
"/API/OData/CampaignExternalActivity/1/ExternalActivities/{key}":{
"get":{
"tags":[
"Reporting/CampaignExternalActivity/1.0/ExternalActivities"
],
"summary":"Get a single External Activity",
"operationId":"ExternalActivities_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"ExternalActivitiesID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"ExternalActivities was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/ExternalActivities"
}
}
},
"404":{
"description":"ExternalActivities does not exist."
}
},
"x-internal-id":"API-OData-CampaignExternalActivity-1-ExternalActivities-{key}-get",
"x-filename-id":"api-odata-campaignexternalactivity-1-externalactivities-key-get"
}
},
"/API/OData/CampaignExternalActivity/1/ExternalActivityAttributes":{
"get":{
"tags":[
"Reporting/CampaignExternalActivity/1.0/ExternalActivityAttributes"
],
"summary":"Get all External Activity Attributes",
"operationId":"ExternalActivityAttributes_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"ExternalActivityAttributes successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/ExternalActivityAttributes"
}
}
}
},
"x-internal-id":"API-OData-CampaignExternalActivity-1-ExternalActivityAttributes-get",
"x-filename-id":"api-odata-campaignexternalactivity-1-externalactivityattributes-get"
}
},
"/API/OData/CampaignExternalActivity/1/ExternalActivityAttributes/{key}":{
"get":{
"tags":[
"Reporting/CampaignExternalActivity/1.0/ExternalActivityAttributes"
],
"summary":"Get a single External Activity Attribute record",
"operationId":"ExternalActivityAttributes_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"ExternalActivityAttributesID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"ExternalActivityAttributes was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/ExternalActivityAttributes"
}
}
}
},
"x-internal-id":"API-OData-CampaignExternalActivity-1-ExternalActivityAttributes-{key}-get",
"x-filename-id":"api-odata-campaignexternalactivity-1-externalactivityattributes-key-get"
}
},
"/api/rest/1.0/data/activities/contact/{id}":{
"get":{
"operationId":"GetActivitiesGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the activity.",
"required":true,
"type":"integer"
},
{
"name":"type",
"in":"query",
"description":"The type of activity you wish to retrieve from the specified contact: emailOpen, emailSend, emailClickThrough, emailSubscribe, emailUnsubscribe, formSubmit, webVisit, or campaignMembership.",
"required":true,
"type":"string"
},
{
"name":"startDate",
"in":"query",
"description":"The start date and time (10 digit integer Unix time).",
"required":true,
"type":"integer"
},
{
"name":"endDate",
"in":"query",
"description":"The end date and time (10 digit integer Unix time).",
"required":true,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"includePending",
"in":"query",
"description":"Include email clickthroughs that are still pending push to the contact activity. Can be set to true or 1 to return pending activities, and false or 0 to not return those activities. Default is false if the parameter is not included in the query.",
"required":false,
"type":"boolean"
}
],
"summary":"Retrieve a list of activities",
"description":"Retrieves all activities that match the criteria specified by the request parameters. Note that the query parameters endDate, startDate, and type are required. See activity detail values for more information about the different activity detail values for each asset type.",
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/ActivityRest10"
}
}
},
"204":{
"description":"No matching activities were found in the search."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Activities"
],
"x-internal-id":"api-rest-1.0-data-activities-contact-{id}-get",
"x-filename-id":"api-rest-1.0-data-activities-contact-id-get"
}
},
"/api/bulk/2.0/events/{id}":{
"get":{
"tags":[
"Bulk/2.0/events"
],
"summary":"Retrieve an event",
"description":"Retrieves an event for the event id provided.",
"operationId":"GetEventIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The event's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"EventIndividualResponse",
"description":"The name of the event.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity.",
"type":"string"
},
"displayNameFieldUri":{
"title":"displayNameFieldUri",
"description":"The relative uri used to reference the event field that represents the display field, for this event.",
"type":"string"
},
"emailAddressFieldUri":{
"title":"emailAddressFieldUri",
"description":"The relative uri used to reference the event field that represents an email address, for this event.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the event definition.",
"type":"string"
},
"uniqueFieldUri":{
"title":"uniqueFieldUri",
"description":"The relative uri used to reference the event field that has a uniqueness constraint on it, for this event.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-events-{id}-get",
"x-filename-id":"api-bulk-2.0-events-id-get"
}
},
"/api/bulk/2.0/events/{id}/exports":{
"get":{
"tags":[
"Bulk/2.0/events"
],
"summary":"Retrieve a list of export definitions for an event",
"description":"Retrieves the list of export definitions for the event with the specified id.",
"operationId":"GetEventExportSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The event's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"EventExportSearchResponse",
"description":"The response body contains information about the event export definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/Export"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-events-{id}-exports-get",
"x-filename-id":"api-bulk-2.0-events-id-exports-get"
}
},
"/api/bulk/2.0/events/{id}/fields":{
"get":{
"tags":[
"Bulk/2.0/events"
],
"summary":"Retrieve a list of the fields for an event",
"description":"Retrieves a list of the fields for the event with the given id.",
"operationId":"GetEventFieldSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The event's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"EventFieldSearchResponse",
"description":"The response body contains information about the event field definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/EventField"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-events-{id}-fields-get",
"x-filename-id":"api-bulk-2.0-events-id-fields-get"
}
},
"/api/bulk/2.0/events/{id}/imports":{
"get":{
"tags":[
"Bulk/2.0/events"
],
"summary":"Retrieve a list of import definitions for an event",
"description":"Retrieves the list of import definitions for the event with the specified id.",
"operationId":"GetEventImportSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The event's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"EventImportSearchResponse",
"description":"The response body contains information about the event import definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/Import"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-events-{id}-imports-get",
"x-filename-id":"api-bulk-2.0-events-id-imports-get"
}
},
"/api/bulk/2.0/events/{parentId}/exports":{
"post":{
"tags":[
"Bulk/2.0/events"
],
"summary":"Create an export definition for an event",
"description":"Creates a new export definition for the specified event. See the tutorial for details on how to export data.",
"operationId":"PostEventExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The event's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"EventExportIndividual",
"in":"body",
"description":"The request body contains details of the event export definition.",
"required":true,
"schema":{
"title":"EventExportIndividual",
"description":"The request body defines the details of the event export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"EventExportIndividualResponse",
"description":"The response body includes information about the event export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-events-{parentId}-exports-post",
"x-filename-id":"api-bulk-2.0-events-parentid-exports-post"
}
},
"/api/bulk/2.0/events/{parentId}/exports/{id}":{
"get":{
"tags":[
"Bulk/2.0/events"
],
"summary":"Retrieve an export definition for an event",
"description":"Retrieves an export definition for the event and export definition ids provided.",
"operationId":"GetEventExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The event's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The event export definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"EventExportIndividualResponse",
"description":"The response body includes information about the event export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-events-{parentId}-exports-{id}-get",
"x-filename-id":"api-bulk-2.0-events-parentid-exports-id-get"
},
"put":{
"tags":[
"Bulk/2.0/events"
],
"summary":"Update an export definition for an event",
"description":"Updates the specified export definition for the specified event.",
"operationId":"PutEventExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The event's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The event export definition's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"EventExportIndividual",
"in":"body",
"description":"The request body contains details of the event export definition.",
"required":true,
"schema":{
"title":"EventExportIndividual",
"description":"The request body defines the details of the event export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"EventExportIndividualResponse",
"description":"The response body includes information about the event export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-events-{parentId}-exports-{id}-put",
"x-filename-id":"api-bulk-2.0-events-parentid-exports-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/events"
],
"summary":"Delete an export definition for an event",
"description":"Deletes the specified event export definition.",
"operationId":"DeleteEventExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The event's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The event export definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-events-{parentId}-exports-{id}-delete",
"x-filename-id":"api-bulk-2.0-events-parentid-exports-id-delete"
}
},
"/api/bulk/2.0/events/{parentId}/exports/{id}/data":{
"get":{
"tags":[
"Bulk/2.0/events"
],
"summary":"Retrieve the synced data for an event export definition",
"description":"Retrieves the synced data for an event export definition. It's recommended to use the sync URI's data endpoint to retrieve export data.",
"operationId":"GetEventExportDataQuery",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The event's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The event export definition's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"EventExportDataQueryResponse",
"description":"The response body includes information about the synced data for the event export definition.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"A list of the event's export data.",
"type":"array",
"items":{
"type":"object"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-events-{parentId}-exports-{id}-data-get",
"x-filename-id":"api-bulk-2.0-events-parentid-exports-id-data-get"
},
"delete":{
"tags":[
"Bulk/2.0/events"
],
"summary":"Delete the synced data for an event export definition",
"description":"Deletes the synced data for the specified event export definition.",
"operationId":"DeleteEventExportDataQuery",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The event's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The event export definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-events-{parentId}-exports-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-events-parentid-exports-id-data-delete"
}
},
"/api/bulk/2.0/events/{parentId}/fields/{id}":{
"get":{
"tags":[
"Bulk/2.0/events"
],
"summary":"Retrieve an event field definition",
"description":"Retrieves an event field definition for the event and field ids provided.",
"operationId":"GetEventFieldIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The event's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The event field's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"EventFieldIndividualResponse",
"description":"The name of the event field.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity.",
"type":"string"
},
"dataType":{
"$ref":"#/definitions/DataType"
},
"defaultValue":{
"title":"defaultValue",
"description":"The field's default value.",
"type":"string"
},
"hasNotNullConstraint":{
"title":"hasNotNullConstraint",
"description":"Indicates whether the field can have null values (i.e. empty).",
"type":"boolean"
},
"hasReadOnlyConstraint":{
"title":"hasReadOnlyConstraint",
"description":"Indicates whether the field can be written to.",
"type":"boolean"
},
"hasUniquenessConstraint":{
"title":"hasUniquenessConstraint",
"description":"Indicates whether the field must have a unique value.",
"type":"boolean"
},
"internalName":{
"title":"internalName",
"description":"The field's internal name (used to uniquely identify it).",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the custom object definition.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-events-{parentId}-fields-{id}-get",
"x-filename-id":"api-bulk-2.0-events-parentid-fields-id-get"
}
},
"/api/bulk/2.0/events/{parentId}/imports":{
"post":{
"tags":[
"Bulk/2.0/events"
],
"summary":"Create an import definition for an event",
"description":"Creates a new import definition for the specified event. See the tutorial for details on how to import data.",
"operationId":"PostEventImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The event's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"EventImportIndividual",
"in":"body",
"description":"The request body contains details of the event import definition.",
"required":true,
"schema":{
"title":"EventImportIndividual",
"description":"The request body defines the details of the event import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"id":{
"title":"id",
"description":"The import definition???s resource identification number.",
"type":"integer"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"mapDataCards":{
"title":"mapDataCards",
"description":"Whether or not data cards will be mapped on import. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsCaseSensitiveMatch":{
"title":"mapDataCardsCaseSensitiveMatch",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsEntityField":{
"title":"mapDataCardsEntityField",
"description":"This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsEntityType":{
"title":"mapDataCardsEntityType",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsSourceField":{
"title":"mapDataCardsSourceField",
"description":"This field specifies the source document field that will be used for matching. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"parentId":{
"title":"parentId",
"description":"The parent object's resource identification number.",
"type":"integer"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"EventImportIndividualResponse",
"description":"The response body includes information about the event import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"mapDataCards":{
"title":"mapDataCards",
"description":"Whether or not data cards will be mapped on import. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsCaseSensitiveMatch":{
"title":"mapDataCardsCaseSensitiveMatch",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsEntityField":{
"title":"mapDataCardsEntityField",
"description":"This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsEntityType":{
"title":"mapDataCardsEntityType",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsSourceField":{
"title":"mapDataCardsSourceField",
"description":"This field specifies the source document field that will be used for matching. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-events-{parentId}-imports-post",
"x-filename-id":"api-bulk-2.0-events-parentid-imports-post"
}
},
"/api/bulk/2.0/events/{parentId}/imports/{id}":{
"get":{
"tags":[
"Bulk/2.0/events"
],
"summary":"Retrieve an import definition for an event",
"description":"Retrieves an import definition for the event and import definition ids provided.",
"operationId":"GetEventImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The event's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The import definition???s resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"EventImportIndividualResponse",
"description":"The response body includes information about the event import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"mapDataCards":{
"title":"mapDataCards",
"description":"Whether or not data cards will be mapped on import. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsCaseSensitiveMatch":{
"title":"mapDataCardsCaseSensitiveMatch",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsEntityField":{
"title":"mapDataCardsEntityField",
"description":"This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsEntityType":{
"title":"mapDataCardsEntityType",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsSourceField":{
"title":"mapDataCardsSourceField",
"description":"This field specifies the source document field that will be used for matching. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-events-{parentId}-imports-{id}-get",
"x-filename-id":"api-bulk-2.0-events-parentid-imports-id-get"
},
"put":{
"tags":[
"Bulk/2.0/events"
],
"summary":"Update an import definition for an event",
"description":"Updates the specified import definition for the specified event.",
"operationId":"PutEventImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The event's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The import definition???s resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"EventImportIndividual",
"in":"body",
"description":"The request body contains details of the event import definition.",
"required":true,
"schema":{
"title":"EventImportIndividual",
"description":"The request body defines the details of the event import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"id":{
"title":"id",
"description":"The import definition???s resource identification number.",
"type":"integer"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"mapDataCards":{
"title":"mapDataCards",
"description":"Whether or not data cards will be mapped on import. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsCaseSensitiveMatch":{
"title":"mapDataCardsCaseSensitiveMatch",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsEntityField":{
"title":"mapDataCardsEntityField",
"description":"This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsEntityType":{
"title":"mapDataCardsEntityType",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsSourceField":{
"title":"mapDataCardsSourceField",
"description":"This field specifies the source document field that will be used for matching. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"parentId":{
"title":"parentId",
"description":"The parent object's resource identification number.",
"type":"integer"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"EventImportIndividualResponse",
"description":"The response body includes information about the event import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"mapDataCards":{
"title":"mapDataCards",
"description":"Whether or not data cards will be mapped on import. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsCaseSensitiveMatch":{
"title":"mapDataCardsCaseSensitiveMatch",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsEntityField":{
"title":"mapDataCardsEntityField",
"description":"This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsEntityType":{
"title":"mapDataCardsEntityType",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsSourceField":{
"title":"mapDataCardsSourceField",
"description":"This field specifies the source document field that will be used for matching. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-events-{parentId}-imports-{id}-put",
"x-filename-id":"api-bulk-2.0-events-parentid-imports-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/events"
],
"summary":"Delete an import definition for an event",
"description":"Deletes the specified event import definition.",
"operationId":"DeleteEventImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The event's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The import definition???s resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-events-{parentId}-imports-{id}-delete",
"x-filename-id":"api-bulk-2.0-events-parentid-imports-id-delete"
}
},
"/api/bulk/2.0/events/{parentId}/imports/{id}/data":{
"post":{
"tags":[
"Bulk/2.0/events"
],
"summary":"Upload data for an event import definition",
"description":"Uploads data for the specified event import definition. When uploading data, Eloqua expects that data to be encoded with UTF-8.",
"operationId":"PostEventImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The event's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The import definition???s resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"EventImportData",
"in":"body",
"description":"The request body contains data to be uploaded to the event import definition.",
"required":true,
"schema":{
"title":"EventImportData",
"type":"array",
"items":{
"title":"EventImportDataItem",
"type":"object",
"items":{
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"EventImportDataResponse",
"description":"Sync response when POSTing event import data, and isSyncTriggeredOnImport is true on the import definition.",
"properties":{
"callbackUrl":{
"title":"callbackUrl",
"description":"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.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"status":{
"$ref":"#/definitions/SyncStatusType"
},
"syncedInstanceUri":{
"title":"syncedInstanceUri",
"description":"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.",
"type":"string"
},
"syncEndedAt":{
"format":"date-time",
"title":"syncEndedAt",
"description":"The date and time the sync ended. This is a read-only property.",
"type":"string"
},
"syncStartedAt":{
"format":"date-time",
"title":"syncStartedAt",
"description":"The date and time the sync started. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-events-{parentId}-imports-{id}-data-post",
"x-filename-id":"api-bulk-2.0-events-parentid-imports-id-data-post"
},
"delete":{
"tags":[
"Bulk/2.0/events"
],
"summary":"Delete the synced data for an event import definition",
"description":"Deletes the synced data for an event import definition",
"operationId":"DeleteEventImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The event's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The import definition???s resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-events-{parentId}-imports-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-events-parentid-imports-id-data-delete"
}
},
"/api/bulk/2.0/events":{
"get":{
"tags":[
"Bulk/2.0/events"
],
"summary":"Retrieve a list of events",
"description":"Retrieves all events that match the criteria specified in the URL parameters.",
"operationId":"GetEventSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"EventSearchResponse",
"description":"The response body contains information about the events.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/Event"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-events-get",
"x-filename-id":"api-bulk-2.0-events-get"
}
},
"/api/rest/2.0/system/countries":{
"get":{
"operationId":"GetCountriesGETRest20",
"parameters":[
],
"summary":"Retrieve a list of countries",
"description":"Retrieve a list of countries",
"responses":{
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Countries"
],
"x-internal-id":"api-rest-2.0-system-countries-get",
"x-filename-id":"api-rest-2.0-system-countries-get"
}
},
"/api/rest/2.0/assets/landingPage":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the landing page to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/LandingPageRest20"
}
}
],
"summary":"Create a landing page",
"description":"Creates a landing page that matches the criteria specified by the request body for htmlContent with a type of RawHtmlContent.\r\n\r\nCreating and updating landing pages with the type ResponsiveHtmlContent is not supported. If you use these endpoints with this landing page type, we cannot guarantee your landing page will be responsive.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/LandingPageRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Landing pages"
],
"x-internal-id":"api-rest-2.0-assets-landingPage-post",
"x-filename-id":"api-rest-2.0-assets-landingpage-post"
}
},
"/api/rest/2.0/assets/landingPage/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the landing page to retrieve.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
},
{
"name":"noMergeContent",
"in":"query",
"description":"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.",
"required":false,
"type":"boolean"
}
],
"summary":"Retrieve a landing page",
"description":"Retrieves the landing page specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/LandingPageRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Landing pages"
],
"x-internal-id":"api-rest-2.0-assets-landingPage-{id}-get",
"x-filename-id":"api-rest-2.0-assets-landingpage-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the landing page to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/LandingPageRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the landing page to update.",
"required":true,
"type":"integer"
}
],
"summary":"Update a landing page",
"description":"Updates the landing page specified by the id parameter.\r\nAll properties should be included in PUT requests, as some properties will be considered blank if not included.\r\nCreating and updating landing pages with the type ResponsiveHtmlContent is not supported. If you use these endpoints with this landing page type, we cannot guarantee your landing page will be responsive.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/LandingPageRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Landing pages"
],
"x-internal-id":"api-rest-2.0-assets-landingPage-{id}-put",
"x-filename-id":"api-rest-2.0-assets-landingpage-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the landing page to delete.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a landing page",
"description":"Deletes the landing page specified by the id parameter.",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Landing pages"
],
"x-internal-id":"api-rest-2.0-assets-landingPage-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-landingpage-id-delete"
}
},
"/api/rest/2.0/assets/landingPages":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered, and the direction. The direction will default to ASC if not specified. See the URL parameters for information.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"Unix timestamp for the date and time the external asset was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of landing pages",
"description":"Retrieves all landing pages that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultLandingPageRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Landing pages"
],
"x-internal-id":"api-rest-2.0-assets-landingPages-get",
"x-filename-id":"api-rest-2.0-assets-landingpages-get"
}
},
"/api/bulk/2.0/campaigns/fields/{id}":{
"get":{
"tags":[
"Bulk/2.0/campaigns"
],
"summary":"Retrieve a campaign field definition",
"description":"This endpoint is not valid.",
"operationId":"GetCampaignFieldIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The campaign field definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CampaignFieldIndividualResponse",
"description":"The response body contains information about the campaign field definition.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataType":{
"$ref":"#/definitions/DataType"
},
"defaultValue":{
"title":"defaultValue",
"description":"The field's default value.",
"type":"string"
},
"hasNotNullConstraint":{
"title":"hasNotNullConstraint",
"description":"Indicates whether the field can have null values (i.e. empty).",
"type":"boolean"
},
"hasReadOnlyConstraint":{
"title":"hasReadOnlyConstraint",
"description":"Indicates whether the field can be written to.",
"type":"boolean"
},
"hasUniquenessConstraint":{
"title":"hasUniquenessConstraint",
"description":"Indicates whether the field must have a unique value.",
"type":"boolean"
},
"internalName":{
"title":"internalName",
"description":"The field's internal name (used to uniquely identify it).",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the campaign field definition.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-campaigns-fields-{id}-get",
"x-filename-id":"api-bulk-2.0-campaigns-fields-id-get"
}
},
"/api/bulk/2.0/campaigns/fields":{
"get":{
"tags":[
"Bulk/2.0/campaigns"
],
"summary":"Retrieve a list of campaign fields",
"description":"Retrieves a list of campaign fields.",
"operationId":"GetCampaignFieldSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
},
{
"name":"type",
"in":"query",
"description":"The value of this query parameter is sourceCampaign, activity, or campaignResponse. Used to return source campaign field statements and what fields are available depending on export type",
"type":"string"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CampaignFieldSearchResponse",
"description":"The response body contains information about the campaign fields.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items returned.",
"type":"array",
"items":{
"$ref":"#/definitions/CampaignField"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-campaigns-fields-get",
"x-filename-id":"api-bulk-2.0-campaigns-fields-get"
}
},
"/api/bulk/2.0/accounts/exports":{
"get":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Retrieve a list of account export definitions",
"description":"Retrieves a list of account export definitions.",
"operationId":"GetAccountExportSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"AccountExportSearchResponse",
"description":"The response body contains information about the account export definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/Export"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-exports-get",
"x-filename-id":"api-bulk-2.0-accounts-exports-get"
},
"post":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Create an account export definition",
"description":"Creates a new account export definition. After a successful request, the next step is to synchronize the data. See the tutorial for details on how to export data.",
"operationId":"PostAccountExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"AccountExportIndividual",
"in":"body",
"description":"The request body contains details of the account export definition.",
"required":true,
"schema":{
"title":"AccountExportIndividual",
"description":"The request body defines the details of the account export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"AccountExportIndividualResponse",
"description":"The response body includes information about the account export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-exports-post",
"x-filename-id":"api-bulk-2.0-accounts-exports-post"
}
},
"/api/bulk/2.0/accounts/exports/{id}":{
"get":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Retrieve an account export definition",
"description":"Retrieves an account export definition.",
"operationId":"GetAccountExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the account export.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"AccountExportIndividualResponse",
"description":"The response body includes information about the account export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-exports-{id}-get",
"x-filename-id":"api-bulk-2.0-accounts-exports-id-get"
},
"put":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Update an account export definition",
"description":"Updates an account export definition.",
"operationId":"PutAccountExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the account export.",
"required":true,
"type":"integer"
},
{
"name":"AccountExportIndividual",
"in":"body",
"description":"The request body contains details of the account export definition.",
"required":true,
"schema":{
"title":"AccountExportIndividual",
"description":"The request body defines the details of the account export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"AccountExportIndividualResponse",
"description":"The response body includes information about the account export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-exports-{id}-put",
"x-filename-id":"api-bulk-2.0-accounts-exports-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Delete an account export definition",
"description":"Deletes an account export definition.",
"operationId":"DeleteAccountExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the account export.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-exports-{id}-delete",
"x-filename-id":"api-bulk-2.0-accounts-exports-id-delete"
}
},
"/api/bulk/2.0/accounts/exports/{id}/data":{
"get":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Retrieve an account export definition's synced data",
"description":"Retrieves an account export definition's synced data.",
"operationId":"GetAccountExportDataQuery",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the account export.",
"required":true,
"type":"integer"
},
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"AccountExportDataQueryResponse",
"description":"Query response when retrieving account export data.",
"properties":{
"count":{
"title":"count",
"description":"The number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"type":"object"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-exports-{id}-data-get",
"x-filename-id":"api-bulk-2.0-accounts-exports-id-data-get"
},
"delete":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Delete an account export definition's data",
"description":"Deletes an account export definition's data.",
"operationId":"DeleteAccountExportDataQuery",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the account export.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-exports-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-accounts-exports-id-data-delete"
}
},
"/api/bulk/2.0/accounts/fields/{id}":{
"get":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Retrieve an account field definition",
"description":"Retrieves an account field definition.",
"operationId":"GetAccountFieldIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the account field.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"AccountFieldIndividualResponse",
"description":"The response body contains information about the account field definition.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataType":{
"$ref":"#/definitions/DataType"
},
"defaultValue":{
"title":"defaultValue",
"description":"The field's default value.",
"type":"string"
},
"hasNotNullConstraint":{
"title":"hasNotNullConstraint",
"description":"Indicates whether the field can have null values (i.e. empty).",
"type":"boolean"
},
"hasReadOnlyConstraint":{
"title":"hasReadOnlyConstraint",
"description":"Indicates whether the field can be written to.",
"type":"boolean"
},
"hasUniquenessConstraint":{
"title":"hasUniquenessConstraint",
"description":"Indicates whether the field must have a unique value.",
"type":"boolean"
},
"internalName":{
"title":"internalName",
"description":"The field's internal name (used to uniquely identify it).",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the account definition.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-fields-{id}-get",
"x-filename-id":"api-bulk-2.0-accounts-fields-id-get"
}
},
"/api/bulk/2.0/accounts/fields":{
"get":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Retrieve a list of account field definitions",
"description":"Retrieves a list of account field definitions.",
"operationId":"GetAccountFieldSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"AccountFieldSearchResponse",
"description":"The response body contains information about the account field definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/AccountField"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-fields-get",
"x-filename-id":"api-bulk-2.0-accounts-fields-get"
}
},
"/api/bulk/2.0/accounts/imports":{
"get":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Retrieve a list of account import definitions",
"description":"Retrieves a list of account import definitions.",
"operationId":"GetAccountImportSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"AccountImportSearchResponse",
"description":"The response body contains information about account import definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/Import"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The actual index from which the records are returned.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-imports-get",
"x-filename-id":"api-bulk-2.0-accounts-imports-get"
},
"post":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Create an account import definition",
"description":"Creates a new account import definition. See the tutorial for details on how to import data.",
"operationId":"PostAccountImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"AccountImportIndividual",
"in":"body",
"description":"The request body contains details of the account import definition.",
"required":true,
"schema":{
"title":"AccountImportIndividual",
"description":"The request body defines the details of the account import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"linkUsers":{
"title":"linkUsers",
"description":"A boolean parameter that enables you to link Eloqua Users to Accounts during an Account import by specifying a CRM User ID.\r\n\r\nIf set to true, one of the following CRM User ID fields is required in the Account import definition: CRMOSCUserId, CRMSfdcUserId, CRMMSDUserId, or CRMSODUserId.\r\n\r\nRefer to the linkUsers parameter in this tutorial for an example.",
"type":"boolean"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"AccountImportIndividualResponse",
"description":"The response body includes information about the account import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"linkUsers":{
"title":"linkUsers",
"description":"A boolean parameter that enables you to link Eloqua Users to Accounts during an Account import by specifying a CRM User ID.\r\n\r\nIf set to true, one of the following CRM User ID fields is required in the Account import definition: CRMOSCUserId, CRMSfdcUserId, CRMMSDUserId, or CRMSODUserId.\r\n\r\nRefer to the linkUsers parameter in this tutorial for an example.",
"type":"boolean"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-imports-post",
"x-filename-id":"api-bulk-2.0-accounts-imports-post"
}
},
"/api/bulk/2.0/accounts/imports/{id}":{
"get":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Retrieve an account import definition",
"description":"Retrieves an account import definition.",
"operationId":"GetAccountImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the account import.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"AccountImportIndividualResponse",
"description":"The response body includes information about the account import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"linkUsers":{
"title":"linkUsers",
"description":"A boolean parameter that enables you to link Eloqua Users to Accounts during an Account import by specifying a CRM User ID.\r\n\r\nIf set to true, one of the following CRM User ID fields is required in the Account import definition: CRMOSCUserId, CRMSfdcUserId, CRMMSDUserId, or CRMSODUserId.\r\n\r\nRefer to the linkUsers parameter in this tutorial for an example.",
"type":"boolean"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-imports-{id}-get",
"x-filename-id":"api-bulk-2.0-accounts-imports-id-get"
},
"put":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Update an account import definition",
"description":"Updates an account import definition.",
"operationId":"PutAccountImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the account import.",
"required":true,
"type":"integer"
},
{
"name":"AccountImportIndividual",
"in":"body",
"description":"The request body contains details of the account import definition.",
"required":true,
"schema":{
"title":"AccountImportIndividual",
"description":"The request body defines the details of the account import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"linkUsers":{
"title":"linkUsers",
"description":"A boolean parameter that enables you to link Eloqua Users to Accounts during an Account import by specifying a CRM User ID.\r\n\r\nIf set to true, one of the following CRM User ID fields is required in the Account import definition: CRMOSCUserId, CRMSfdcUserId, CRMMSDUserId, or CRMSODUserId.\r\n\r\nRefer to the linkUsers parameter in this tutorial for an example.",
"type":"boolean"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"AccountImportIndividualResponse",
"description":"The response body includes information about the account import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"linkUsers":{
"title":"linkUsers",
"description":"A boolean parameter that enables you to link Eloqua Users to Accounts during an Account import by specifying a CRM User ID.\r\n\r\nIf set to true, one of the following CRM User ID fields is required in the Account import definition: CRMOSCUserId, CRMSfdcUserId, CRMMSDUserId, or CRMSODUserId.\r\n\r\nRefer to the linkUsers parameter in this tutorial for an example.",
"type":"boolean"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-imports-{id}-put",
"x-filename-id":"api-bulk-2.0-accounts-imports-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Delete an account import definition",
"description":"Deletes an account import definition.",
"operationId":"DeleteAccountImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the account import.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-imports-{id}-delete",
"x-filename-id":"api-bulk-2.0-accounts-imports-id-delete"
}
},
"/api/bulk/2.0/accounts/imports/{id}/data":{
"post":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Upload data for a specified account import definition",
"description":"Uploads data for a specified account import definition. For more information on uploading Account data, see the tutorial. When uploading data, Eloqua expects that data to be encoded with UTF-8.",
"operationId":"PostAccountImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the account import.",
"required":true,
"type":"integer"
},
{
"name":"AccountImportData",
"in":"body",
"description":"The request body contains data to be uploaded to the account import definition.",
"required":true,
"schema":{
"title":"AccountImportData",
"type":"array",
"items":{
"title":"AccountImportDataItem",
"type":"object",
"items":{
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"AccountImportDataResponse",
"description":"Sync response when POSTing account import data, and isSyncTriggeredOnImport = true on the import definition.",
"properties":{
"callbackUrl":{
"title":"callbackUrl",
"description":"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.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"status":{
"$ref":"#/definitions/SyncStatusType"
},
"syncedInstanceUri":{
"title":"syncedInstanceUri",
"description":"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.",
"type":"string"
},
"syncEndedAt":{
"format":"date-time",
"title":"syncEndedAt",
"description":"The date and time the sync ended. This is a read-only property.",
"type":"string"
},
"syncStartedAt":{
"format":"date-time",
"title":"syncStartedAt",
"description":"The date and time the sync started. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"204":{
"description":"No content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-imports-{id}-data-post",
"x-filename-id":"api-bulk-2.0-accounts-imports-id-data-post"
},
"delete":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Delete an account import definition's data",
"description":"Deletes an account import definition's data.",
"operationId":"DeleteAccountImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the account import.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-imports-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-accounts-imports-id-data-delete"
}
},
"/api/bulk/2.0/accounts/lists/{id}":{
"get":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Retrieve an account list definition",
"description":"Retrieves an account list definition.",
"operationId":"GetAccountListIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The account field definition's unique resource identifier.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"AccountListIndividualResponse",
"description":"The response body contains information about the account list definition.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the account definition.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-lists-{id}-get",
"x-filename-id":"api-bulk-2.0-accounts-lists-id-get"
}
},
"/api/bulk/2.0/accounts/lists":{
"get":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Retrieve a list of account list definitions",
"description":"Retrieves a list of account list definitions.",
"operationId":"GetAccountListSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"AccountListSearchResponse",
"description":"The response body contains information about the account list definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/AccountList"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The actual index from which the records are returned.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-lists-get",
"x-filename-id":"api-bulk-2.0-accounts-lists-get"
}
},
"/api/bulk/2.0/accounts/syncActions":{
"get":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Retrieve a list of account sync action definitions",
"description":"Retrieves a list of account sync action definitions.",
"operationId":"GetAccountSyncActionOperationSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"AccountSyncActionOperationSearchResponse",
"description":"The response body contains information about the sync action definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncActionOperation"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-syncActions-get",
"x-filename-id":"api-bulk-2.0-accounts-syncactions-get"
},
"post":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Create an account sync action definition",
"description":"Creates a new account sync action definition.",
"operationId":"PostAccountSyncActionOperationIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"AccountSyncActionOperationIndividual",
"in":"body",
"description":"The request body defines details of the account sync action definition.",
"required":true,
"schema":{
"title":"AccountSyncActionOperationIndividual",
"description":"The request body defines the details of the account sync action definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the sync action. This is a read-only property.",
"type":"string"
},
"fields":{
"title":"fields",
"description":"The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field.\r\n\r\nAllowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}.\r\n\r\nAllowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}.\r\n\r\nAllowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered upon uploading data.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kb. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the sync action definition.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. \r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"AccountSyncActionOperationIndividualResponse",
"description":"The response body includes information about the account sync action definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the sync action. This is a read-only property.",
"type":"string"
},
"fields":{
"title":"fields",
"description":"The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field.\r\n\r\nAllowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}.\r\n\r\nAllowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}.\r\n\r\nAllowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered upon uploading data.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kb. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the sync action definition.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. \r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-syncActions-post",
"x-filename-id":"api-bulk-2.0-accounts-syncactions-post"
}
},
"/api/bulk/2.0/accounts/syncActions/{id}":{
"get":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Retrieve an account sync action definition",
"description":"Retrieves an account sync action definition.",
"operationId":"GetAccountSyncActionOperationIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The sync action definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"Success.",
"schema":{
"title":"AccountSyncActionOperationIndividualResponse",
"description":"The response body includes information about the account sync action definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the sync action. This is a read-only property.",
"type":"string"
},
"fields":{
"title":"fields",
"description":"The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field.\r\n\r\nAllowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}.\r\n\r\nAllowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}.\r\n\r\nAllowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered upon uploading data.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kb. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the sync action definition.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. \r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-syncActions-{id}-get",
"x-filename-id":"api-bulk-2.0-accounts-syncactions-id-get"
},
"put":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Update an account sync action definition",
"description":"Updates an account sync action definition. For PUT requests, the parameters below are required for validation, even if they are not changing.",
"operationId":"PutAccountSyncActionOperationIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The sync action definition's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"AccountSyncActionOperationIndividual",
"in":"body",
"description":"The request body defines details of the account sync action definition.",
"required":true,
"schema":{
"title":"AccountSyncActionOperationIndividual",
"description":"The request body defines the details of the account sync action definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the sync action. This is a read-only property.",
"type":"string"
},
"fields":{
"title":"fields",
"description":"The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field.\r\n\r\nAllowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}.\r\n\r\nAllowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}.\r\n\r\nAllowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered upon uploading data.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kb. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the sync action definition.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. \r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"Success.",
"schema":{
"title":"AccountSyncActionOperationIndividualResponse",
"description":"The response body includes information about the account sync action definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the sync action. This is a read-only property.",
"type":"string"
},
"fields":{
"title":"fields",
"description":"The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field.\r\n\r\nAllowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}.\r\n\r\nAllowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}.\r\n\r\nAllowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered upon uploading data.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kb. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the sync action definition.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. \r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-syncActions-{id}-put",
"x-filename-id":"api-bulk-2.0-accounts-syncactions-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Delete an account sync action definition",
"description":"Deletes the specified account sync action definition.",
"operationId":"DeleteAccountSyncActionOperationIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The sync action definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-syncActions-{id}-delete",
"x-filename-id":"api-bulk-2.0-accounts-syncactions-id-delete"
}
},
"/api/bulk/2.0/accounts/syncActions/{id}/data":{
"post":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Upload account sync action data",
"description":"Uploads account sync action data.",
"operationId":"PostAccountSyncActionOperationData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The sync action definition's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"AccountSyncActionOperationData",
"in":"body",
"description":"The request body contains details of the account sync action data.",
"required":true,
"schema":{
"title":"AccountSyncActionOperationData",
"type":"array",
"items":{
"title":"AccountSyncActionOperationDataItem",
"type":"object",
"items":{
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"AccountSyncActionOperationDataResponse",
"description":"Sync response when POSTing account sync action data, and isSyncTriggeredOnImport = true on the sync action definition.",
"properties":{
"callbackUrl":{
"title":"callbackUrl",
"description":"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.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"status":{
"$ref":"#/definitions/SyncStatusType"
},
"syncedInstanceUri":{
"title":"syncedInstanceUri",
"description":"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.",
"type":"string"
},
"syncEndedAt":{
"format":"date-time",
"title":"syncEndedAt",
"description":"The date and time the sync ended. This is a read-only property.",
"type":"string"
},
"syncStartedAt":{
"format":"date-time",
"title":"syncStartedAt",
"description":"The date and time the sync started. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"204":{
"description":"No content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-syncActions-{id}-data-post",
"x-filename-id":"api-bulk-2.0-accounts-syncactions-id-data-post"
},
"delete":{
"tags":[
"Bulk/2.0/accounts"
],
"summary":"Delete sync data for an account sync action definition",
"description":"Deletes sync data for an account sync action definition.",
"operationId":"DeleteAccountSyncActionOperationData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The sync action definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-accounts-syncActions-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-accounts-syncactions-id-data-delete"
}
},
"/api/rest/2.0/data/eventRegistration/{parentId}/instance":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the event registrant to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/EventRegistrationDataRest20"
}
},
{
"name":"parentId",
"in":"path",
"description":"Id of the parent event.",
"required":true,
"type":"integer"
}
],
"summary":"Create an event registrant",
"description":"Creates an event registrant that matches the criteria specified by the request body for the event specified by the parentId parameter.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/EventRegistrationDataRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Event registrants"
],
"x-internal-id":"api-rest-2.0-data-eventRegistration-{parentId}-instance-post",
"x-filename-id":"api-rest-2.0-data-eventregistration-parentid-instance-post"
}
},
"/api/rest/2.0/data/eventRegistration/{parentId}/instance/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"Id of the parent event.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"Id of the event registrant.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"This parameter is not used for this endpoint.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve an event registrant",
"description":"Retrieves the registrant for the event specified by the parentId and id parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/EventRegistrationDataRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Event registrants"
],
"x-internal-id":"api-rest-2.0-data-eventRegistration-{parentId}-instance-{id}-get",
"x-filename-id":"api-rest-2.0-data-eventregistration-parentid-instance-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the event registrant to be updated. Note: Only fieldValues and contactId can be updated. fieldValues is required, even if not updating any fields. To update contactId, include fieldValues with an empty array.",
"required":true,
"schema":{
"$ref":"#/definitions/EventRegistrationDataRest20"
}
},
{
"name":"parentId",
"in":"path",
"description":"Id of the parent event.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"Id of the event registrant.",
"required":true,
"type":"integer"
}
],
"summary":"Update an event registrant",
"description":"Updates an event registrant that matches the criteria specified by the request body for the event specified by the parentId parameter. The response will only include field values that have been updated in the request. The response will also only include contactId if it has been updated in the request.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/EventRegistrationDataRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Event registrants"
],
"x-internal-id":"api-rest-2.0-data-eventRegistration-{parentId}-instance-{id}-put",
"x-filename-id":"api-rest-2.0-data-eventregistration-parentid-instance-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"Id of the parent event.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"Id of the event registrant.",
"required":true,
"type":"integer"
}
],
"summary":"Delete an event registrant",
"description":"Deletes registrant for the event specified by the parentId and id parameters",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Event registrants"
],
"x-internal-id":"api-rest-2.0-data-eventRegistration-{parentId}-instance-{id}-delete",
"x-filename-id":"api-rest-2.0-data-eventregistration-parentid-instance-id-delete"
}
},
"/api/rest/2.0/data/eventRegistration/{parentId}/instances":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"Id of the parent event.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"This parameter is not used for this endpoint.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a list of event registrants",
"description":"Retrieves the registrants (records) for an event specified by the parentId that match the criteria specified by the query parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultEventRegistrationDataRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Event registrants"
],
"x-internal-id":"api-rest-2.0-data-eventRegistration-{parentId}-instances-get",
"x-filename-id":"api-rest-2.0-data-eventregistration-parentid-instances-get"
}
},
"/api/rest/1.0/data/form/{id}":{
"post":{
"operationId":"CreateIndividualPOSTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the form data to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/FormDataRest10"
}
},
{
"name":"id",
"in":"path",
"description":"ID of the form.",
"required":true,
"type":"integer"
}
],
"summary":"Create form data for a single form",
"description":"Creates form data for the form that matches the criteria specified by the request body. This endpoint will only create form data specified in the request body, including static values in form fields. If a form field contains a static value, the field must be included in the request body to update the static value.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/FormDataRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Form data"
],
"x-internal-id":"api-rest-1.0-data-form-{id}-post",
"x-filename-id":"api-rest-1.0-data-form-id-post"
},
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"ID of the form.",
"required":true,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"startAt",
"in":"query",
"description":"The earliest date time for which the request will retrieve data, expressed in Unix time.",
"required":false,
"type":"integer"
},
{
"name":"endAt",
"in":"query",
"description":"The latest date time for which the request will retrieve data, expressed in Unix time.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve processed form data for a single form",
"description":"Retrieves the form data for the form specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultFormSubmissionRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Form data"
],
"x-internal-id":"api-rest-1.0-data-form-{id}-get",
"x-filename-id":"api-rest-1.0-data-form-id-get"
}
},
"/api/rest/1.0/data/form/{formId}/formData/{formSubmitJobId}":{
"get":{
"operationId":"GetAsyncFormSubmissionGETRest10",
"parameters":[
{
"name":"formId",
"in":"path",
"description":"ID of the form.",
"required":true,
"type":"string"
},
{
"name":"formSubmitJobId",
"in":"path",
"description":"ID of the asynchronous form submission job.",
"required":true,
"type":"string"
}
],
"summary":"Retrieve a single form submit job",
"description":"Retrieves asynchronous form submission data for a single form submit specified by the formId and formSubmitJobId parameters. This API endpoint is released under our Controlled Availability program. You can request access to this feature by submitting a request to My Oracle Support.",
"responses":{
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Form data"
],
"x-internal-id":"api-rest-1.0-data-form-{formId}-formData-{formSubmitJobId}-get",
"x-filename-id":"api-rest-1.0-data-form-formid-formdata-formsubmitjobid-get"
}
},
"/api/rest/1.0/data/form/{formId}/formData":{
"get":{
"operationId":"SearchAsyncFormSubmissionGETRest10",
"parameters":[
{
"name":"formId",
"in":"path",
"description":"ID of the form.",
"required":true,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"string"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"string"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"startAt",
"in":"query",
"description":"The earliest date time for which the request will retrieve data, expressed in Unix time.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve all form submit jobs for a single form",
"description":"Retrieves all asynchronous form submissions for a form specified by the formId. This API endpoint is released under our Controlled Availability program. You can request access to this feature by submitting a request to My Oracle Support.",
"responses":{
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Form data"
],
"x-internal-id":"api-rest-1.0-data-form-{formId}-formData-get",
"x-filename-id":"api-rest-1.0-data-form-formid-formdata-get"
}
},
"/API/OData/AccountActivity/1/Account":{
"get":{
"tags":[
"Reporting/AccountActivity/1.0/Account"
],
"summary":"Get all Accounts",
"operationId":"Account_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Accounts successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Account"
}
}
}
},
"x-internal-id":"API-OData-AccountActivity-1-Account-get",
"x-filename-id":"api-odata-accountactivity-1-account-get"
}
},
"/API/OData/AccountActivity/1/Account/{key}":{
"get":{
"tags":[
"Reporting/AccountActivity/1.0/Account"
],
"summary":"Get a single Account",
"operationId":"Account_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"Account ID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Account was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Account"
}
}
}
},
"x-internal-id":"API-OData-AccountActivity-1-Account-{key}-get",
"x-filename-id":"api-odata-accountactivity-1-account-key-get"
}
},
"/API/OData/AccountActivity/1/Account/AccountIDByAccountName(AccountName='{AccountName}')":{
"get":{
"tags":[
"Reporting/AccountActivity/1.0/Account"
],
"summary":"Get Account ID from Account name",
"operationId":"Account_AccountIDByAccountName",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"AccountName",
"in":"path",
"description":"Account Name",
"required":true,
"type":"string"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
}
},
"x-internal-id":"API-OData-AccountActivity-1-Account-AccountIDByAccountName(AccountName='{AccountName}')-get",
"x-filename-id":"api-odata-accountactivity-1-account-accountidbyaccountname-accountnameaccountname-get"
}
},
"/API/OData/AccountActivity/1/Account/AccountIDByCompanyName(CompanyName='{CompanyName}')":{
"get":{
"tags":[
"Reporting/AccountActivity/1.0/Account"
],
"summary":"Get Company Name from Account ID",
"operationId":"Account_AccountIDByCompanyName",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"CompanyName",
"in":"path",
"description":"Company Name",
"required":true,
"type":"string"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
}
},
"x-internal-id":"API-OData-AccountActivity-1-Account-AccountIDByCompanyName(CompanyName='{CompanyName}')-get",
"x-filename-id":"api-odata-accountactivity-1-account-accountidbycompanyname-companynamecompanyname-get"
}
},
"/API/OData/AccountActivity/1/AccountEngagement":{
"get":{
"tags":[
"Reporting/AccountActivity/1.0/AccountEngagement"
],
"summary":"Get all Account Engagements",
"operationId":"AccountEngagement_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"AccountsEngagements successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/AccountEngagement"
}
}
}
},
"x-internal-id":"API-OData-AccountActivity-1-AccountEngagement-get",
"x-filename-id":"api-odata-accountactivity-1-accountengagement-get"
}
},
"/API/OData/AccountActivity/1/AccountEngagement/{key}":{
"get":{
"tags":[
"Reporting/AccountActivity/1.0/AccountEngagement"
],
"summary":"Get a single Account Engagement",
"operationId":"AccountEngagement_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"Account ID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"AccountEngagement was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/AccountEngagement"
}
}
}
},
"x-internal-id":"API-OData-AccountActivity-1-AccountEngagement-{key}-get",
"x-filename-id":"api-odata-accountactivity-1-accountengagement-key-get"
}
},
"/api/rest/2.0/assets/customObject":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the custom object to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/CustomObjectRest20"
}
}
],
"summary":"Create a custom object",
"description":"Creates a custom object that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/CustomObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Custom objects"
],
"x-internal-id":"api-rest-2.0-assets-customObject-post",
"x-filename-id":"api-rest-2.0-assets-customobject-post"
}
},
"/api/rest/2.0/assets/customObject/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the custom object",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a custom object",
"description":"Retrieves the custom object specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/CustomObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Custom objects"
],
"x-internal-id":"api-rest-2.0-assets-customObject-{id}-get",
"x-filename-id":"api-rest-2.0-assets-customobject-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the custom object to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/CustomObjectRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the custom object.",
"required":true,
"type":"integer"
}
],
"summary":"Update a custom object",
"description":"Updates the custom object specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/CustomObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Custom objects"
],
"x-internal-id":"api-rest-2.0-assets-customObject-{id}-put",
"x-filename-id":"api-rest-2.0-assets-customobject-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the custom object",
"required":true,
"type":"integer"
}
],
"summary":"Delete a custom object",
"description":"Deletes the custom object specified by the id parameter.",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Custom objects"
],
"x-internal-id":"api-rest-2.0-assets-customObject-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-customobject-id-delete"
}
},
"/api/rest/2.0/assets/customObjects":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"Unix timestamp for the date and time the custom object was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of custom objects",
"description":"Retrieves all custom objects that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultCustomObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Custom objects"
],
"x-internal-id":"api-rest-2.0-assets-customObjects-get",
"x-filename-id":"api-rest-2.0-assets-customobjects-get"
}
},
"/api/bulk/2.0/syncActions":{
"get":{
"tags":[
"Bulk/2.0/syncActions"
],
"summary":"Retrieve a list of sync action definitions",
"description":"Retrieves a list of sync action definitions.",
"operationId":"GetSyncActionOperationSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"SyncActionOperationSearchResponse",
"description":"The response body contains information about the sync action definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"List of sync action definitions.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncActionOperation"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-syncActions-get",
"x-filename-id":"api-bulk-2.0-syncactions-get"
}
},
"/api/rest/2.0/data/visitors":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"Specifies which page of visitors to return (the count parameter defines the number of visitors per page). If the page parameter is not supplied, 1 will be used by default.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered. Possible values include: visitorId, contactId, externalId, customerGuid, v_IPAddress, and v_LastVisitDateAndTime.",
"required":false,
"type":"string"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve visitor data",
"description":"Retrieves all visitor data that matches the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultVisitorViewDataRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Visitors"
],
"x-internal-id":"api-rest-2.0-data-visitors-get",
"x-filename-id":"api-rest-2.0-data-visitors-get"
},
"post":{
"operationId":"SearchPostSEARCHRest20",
"parameters":[
{
"name":"search",
"in":"body",
"description":"The request body defines the details of the request.",
"required":true,
"schema":{
"$ref":"#/definitions/EntitySearchByExternalIdsRest20"
}
},
{
"name":"X-HTTP-Method-Override",
"in":"header",
"description":"The request header X-HTTP-Method-Override must be set with value SEARCH.",
"required":true,
"type":"string",
"format":"string",
"default":"SEARCH"
}
],
"summary":"Retrieve visitor data by visitor GUID",
"description":"Retrieves visitor data for up to 200 visitors, searched by visitor GUID, aka externalId. Use the depth parameter when making the request to specify the visitor information returned in the response.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultVisitorViewDataRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Visitors"
],
"x-internal-id":"api-rest-2.0-data-visitors-post",
"x-filename-id":"api-rest-2.0-data-visitors-post"
}
},
"/api/rest/1.0/assets/email/header":{
"post":{
"operationId":"CreateIndividualPOSTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the email header to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/EmailHeaderRest10"
}
}
],
"summary":"Create an email header",
"description":"Creates an email header that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/EmailHeaderRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email headers"
],
"x-internal-id":"api-rest-1.0-assets-email-header-post",
"x-filename-id":"api-rest-1.0-assets-email-header-post"
}
},
"/api/rest/1.0/assets/email/header/{id}":{
"get":{
"operationId":"ReadIndividualGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the email header to be retrieved.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve an email header",
"description":"Retrieves the email header specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/EmailHeaderRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email headers"
],
"x-internal-id":"api-rest-1.0-assets-email-header-{id}-get",
"x-filename-id":"api-rest-1.0-assets-email-header-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the email header to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/EmailHeaderRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the email header to update.",
"required":true,
"type":"integer"
}
],
"summary":"Update an email header",
"description":"Updates the email header specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/EmailHeaderRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email headers"
],
"x-internal-id":"api-rest-1.0-assets-email-header-{id}-put",
"x-filename-id":"api-rest-1.0-assets-email-header-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the email header to be deleted.",
"required":true,
"type":"integer"
}
],
"summary":"Delete an email header",
"description":"Deletes the email header specified by the id parameter.",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email headers"
],
"x-internal-id":"api-rest-1.0-assets-email-header-{id}-delete",
"x-filename-id":"api-rest-1.0-assets-email-header-id-delete"
}
},
"/api/rest/1.0/assets/email/headers":{
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"When the email header was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of email headers",
"description":"Retrieves all email headers that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultHeaderRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email headers"
],
"x-internal-id":"api-rest-1.0-assets-email-headers-get",
"x-filename-id":"api-rest-1.0-assets-email-headers-get"
}
},
"/api/rest/2.0/assets/email":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the email to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/EmailRest20"
}
}
],
"summary":"Create an email",
"description":"Creates an email that matches the criteria specified by the request body for htmlContent with a type of RawHtmlContent. Creating emails with the type ResponsiveHtmlContent is not supported. If you use this endpoint with this email type, we cannot guarantee your email will be responsive.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/EmailRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Emails"
],
"x-internal-id":"api-rest-2.0-assets-email-post",
"x-filename-id":"api-rest-2.0-assets-email-post"
}
},
"/api/rest/2.0/assets/email/{id}":{
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the email to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/EmailRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the email.",
"required":true,
"type":"integer"
}
],
"summary":"Update an email",
"description":"Updates the email specified by the id parameter. Updating emails with the type ResponsiveHtmlContent is not supported. If you use this endpoint with this email type, we cannot guarantee your email will be responsive. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/EmailRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Emails"
],
"x-internal-id":"api-rest-2.0-assets-email-{id}-put",
"x-filename-id":"api-rest-2.0-assets-email-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the email.",
"required":true,
"type":"integer"
}
],
"summary":"Delete an email",
"description":"Deletes the email specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Emails"
],
"x-internal-id":"api-rest-2.0-assets-email-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-email-id-delete"
},
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the email.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
},
{
"name":"preMerge",
"in":"query",
"description":"This property is used by Oracle Engage.",
"required":false,
"type":"boolean"
},
{
"name":"noMergeContent",
"in":"query",
"description":"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.",
"required":false,
"type":"boolean"
}
],
"summary":"Retrieve an email",
"description":"Retrieves the email specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/EmailRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Emails"
],
"x-internal-id":"api-rest-2.0-assets-email-{id}-get",
"x-filename-id":"api-rest-2.0-assets-email-id-get"
}
},
"/api/rest/2.0/assets/emails":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
},
{
"name":"includeAvailable",
"in":"query",
"description":"Specifies whether to include unarchived emails in the results, considered true if not specified.",
"required":false,
"type":"boolean"
},
{
"name":"includeArchived",
"in":"query",
"description":"Specifies whether to include archived emails in the results, considered false if not specified.",
"required":false,
"type":"boolean"
}
],
"summary":"Retrieve a list of emails",
"description":"Retrieves all emails that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultEmailRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Emails"
],
"x-internal-id":"api-rest-2.0-assets-emails-get",
"x-filename-id":"api-rest-2.0-assets-emails-get"
}
},
"/api/rest/2.0/assets/email/{id}/archive":{
"post":{
"operationId":"ArchiveIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the parameters for archiving the email.",
"required":true,
"schema":{
"$ref":"#/definitions/ArchiveParameterRest20"
}
},
{
"name":"id",
"in":"path",
"description":"ID of the email to be archived.",
"required":true,
"type":"integer"
}
],
"summary":"Archive an email",
"description":"Archives the email specified by the id parameter.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/EmailRest20"
}
},
"304":{
"description":"Not Modified. See Status Codes for information about other possible HTTP status codes."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Emails"
],
"x-internal-id":"api-rest-2.0-assets-email-{id}-archive-post",
"x-filename-id":"api-rest-2.0-assets-email-id-archive-post"
}
},
"/api/rest/2.0/assets/email/{id}/unarchive":{
"post":{
"operationId":"UnarchiveIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the parameters for unarchiving the email.",
"required":true,
"schema":{
"$ref":"#/definitions/ArchiveParameterRest20"
}
},
{
"name":"id",
"in":"path",
"description":"ID of the email to be unarchived.",
"required":true,
"type":"integer"
}
],
"summary":"Unarchive an email",
"description":"Unarchives the email specified by the ID parameter.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/EmailRest20"
}
},
"304":{
"description":"Not Modified. See Status Codes for information about other possible HTTP status codes."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Emails"
],
"x-internal-id":"api-rest-2.0-assets-email-{id}-unarchive-post",
"x-filename-id":"api-rest-2.0-assets-email-id-unarchive-post"
}
},
"/api/bulk/2.0/phoneNumbers/imports":{
"get":{
"tags":[
"Bulk/2.0/phoneNumbers"
],
"summary":"Retrieve a list of phone number import definitions",
"description":"Retrieves a list of phone number import definitions",
"operationId":"GetPhoneNumberImportSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"PhoneNumberImportSearchResponse",
"description":"The response body contains information about the phone number import.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items returned.",
"type":"array",
"items":{
"$ref":"#/definitions/Import"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-phoneNumbers-imports-get",
"x-filename-id":"api-bulk-2.0-phonenumbers-imports-get"
},
"post":{
"tags":[
"Bulk/2.0/phoneNumbers"
],
"summary":"Create a phone number import definition",
"description":"Creates a new phone number import definition. See the tutorial for details on how to import data.",
"operationId":"PostPhoneNumberImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"PhoneNumberImportIndividual",
"in":"body",
"description":"The request body contains details of the phone number import definition.",
"required":true,
"schema":{
"title":"PhoneNumberImportIndividual",
"description":"The request body defines the details of the phone number import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"PhoneNumberImportIndividualResponse",
"description":"The response body contains information about the phone number import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-phoneNumbers-imports-post",
"x-filename-id":"api-bulk-2.0-phonenumbers-imports-post"
}
},
"/api/bulk/2.0/phoneNumbers/imports/{id}":{
"get":{
"tags":[
"Bulk/2.0/phoneNumbers"
],
"summary":"Retrieve a phone number import definition",
"description":"This endpoint is not valid.",
"operationId":"GetPhoneNumberImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The phone number import definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"PhoneNumberImportIndividualResponse",
"description":"The response body contains information about the phone number import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-phoneNumbers-imports-{id}-get",
"x-filename-id":"api-bulk-2.0-phonenumbers-imports-id-get"
},
"put":{
"tags":[
"Bulk/2.0/phoneNumbers"
],
"summary":"Update an phone number import definition",
"description":"Updates an phone number import definition.",
"operationId":"PutPhoneNumberImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The phone number import definition's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"PhoneNumberImportIndividual",
"in":"body",
"description":"The request body contains details of the phone number import definition.",
"required":true,
"schema":{
"title":"PhoneNumberImportIndividual",
"description":"The request body defines the details of the phone number import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"PhoneNumberImportIndividualResponse",
"description":"The response body contains information about the phone number import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-phoneNumbers-imports-{id}-put",
"x-filename-id":"api-bulk-2.0-phonenumbers-imports-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/phoneNumbers"
],
"summary":"Delete a phone number import definition",
"description":"Deletes a phone number import definition.",
"operationId":"DeletePhoneNumberImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The phone number import definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-phoneNumbers-imports-{id}-delete",
"x-filename-id":"api-bulk-2.0-phonenumbers-imports-id-delete"
}
},
"/api/bulk/2.0/phoneNumbers/imports/{id}/data":{
"post":{
"tags":[
"Bulk/2.0/phoneNumbers"
],
"summary":"Upload data for a specified phone number import definition",
"description":"Uploads data for a specified phone number import definition. For more information on uploading phone number data, see the tutorial. When uploading data, Eloqua expects that data to be encoded with UTF-8.",
"operationId":"PostPhoneNumberImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The phone number import definition's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"PhoneNumberImportData",
"in":"body",
"description":"The request body contains data to be uploaded to the phone number import definition.",
"required":true,
"schema":{
"title":"PhoneNumberImportData",
"type":"array",
"items":{
"title":"PhoneNumberImportDataItem",
"type":"object",
"items":{
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"PhoneNumberImportDataResponse",
"description":"Sync response when POSTing phone number import data, and isSyncTriggeredOnImport = true on the import definition.",
"properties":{
"callbackUrl":{
"title":"callbackUrl",
"description":"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.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"status":{
"$ref":"#/definitions/SyncStatusType"
},
"syncedInstanceUri":{
"title":"syncedInstanceUri",
"description":"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.",
"type":"string"
},
"syncEndedAt":{
"format":"date-time",
"title":"syncEndedAt",
"description":"The date and time the sync ended. This is a read-only property.",
"type":"string"
},
"syncStartedAt":{
"format":"date-time",
"title":"syncStartedAt",
"description":"The date and time the sync started. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-phoneNumbers-imports-{id}-data-post",
"x-filename-id":"api-bulk-2.0-phonenumbers-imports-id-data-post"
},
"delete":{
"tags":[
"Bulk/2.0/phoneNumbers"
],
"summary":"Delete an phone number import definition's data",
"description":"Deletes an phone number import definition's data.",
"operationId":"DeletePhoneNumberImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The phone number import definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-phoneNumbers-imports-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-phonenumbers-imports-id-data-delete"
}
},
"/api/rest/2.0/assets/external":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the external asset to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/ExternalAssetRest20"
}
}
],
"summary":"Create an external asset",
"description":"Creates an external asset that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/ExternalAssetRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. This name is used by another asset."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/External assets"
],
"x-internal-id":"api-rest-2.0-assets-external-post",
"x-filename-id":"api-rest-2.0-assets-external-post"
}
},
"/api/rest/2.0/assets/external/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the external asset.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve an external asset",
"description":"Retrieves the external asset specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/ExternalAssetRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/External assets"
],
"x-internal-id":"api-rest-2.0-assets-external-{id}-get",
"x-filename-id":"api-rest-2.0-assets-external-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the external asset to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/ExternalAssetRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the external asset.",
"required":true,
"type":"integer"
}
],
"summary":"Update an external asset",
"description":"Updates the external asset specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/ExternalAssetRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. This name is used by another asset."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/External assets"
],
"x-internal-id":"api-rest-2.0-assets-external-{id}-put",
"x-filename-id":"api-rest-2.0-assets-external-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the external asset to delete.",
"required":true,
"type":"integer"
}
],
"summary":"Delete an external asset",
"description":"Deletes the external asset specified by the id parameter.",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/External assets"
],
"x-internal-id":"api-rest-2.0-assets-external-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-external-id-delete"
}
},
"/api/rest/2.0/assets/externals":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"Unix timestamp for the date and time the external asset was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of external assets",
"description":"Retrieves a list of external assets.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultExternalAssetRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/External assets"
],
"x-internal-id":"api-rest-2.0-assets-externals-get",
"x-filename-id":"api-rest-2.0-assets-externals-get"
}
},
"/api/rest/2.0/data/activities/contact/{id}/{type}":{
"get":{
"operationId":"GetActivitiesGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the contact whose activity to retrieve.",
"required":true,
"type":"integer"
},
{
"name":"type",
"in":"path",
"description":"Type of the activity to retrieve.",
"required":true,
"type":"string"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"startAt",
"in":"query",
"description":"The earliest date time for which the request will retrieve data, expressed in Unix time.",
"required":true,
"type":"integer"
},
{
"name":"endAt",
"in":"query",
"description":"The end date time for which the request will retrieve data, expressed in Unix time.",
"required":true,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"includePending",
"in":"query",
"description":"Include email clickthroughs that are still pending push to the contact activity. Can be set to true or 1 to return pending activities, and false or 0 to not return those activities. Default is false if the parameter is not included in the query.",
"required":false,
"type":"boolean"
}
],
"summary":"Retrieve a list of activities.",
"description":"Retrieves a list of contact activities specified by id and type parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultActivityRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Activities"
],
"x-internal-id":"api-rest-2.0-data-activities-contact-{id}-{type}-get",
"x-filename-id":"api-rest-2.0-data-activities-contact-id-type-get"
}
},
"/api/bulk/2.0/syncs":{
"get":{
"tags":[
"Bulk/2.0/syncs"
],
"summary":"Retrieve a list of syncs",
"description":"Retrieves a list of syncs.",
"operationId":"GetSyncSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"SyncSearchResponse",
"description":"The response body contains information about synchronizations.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/Sync"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-syncs-get",
"x-filename-id":"api-bulk-2.0-syncs-get"
},
"post":{
"tags":[
"Bulk/2.0/syncs"
],
"summary":"Create an import or export sync",
"description":"Creates an import or export sync.",
"operationId":"PostSyncIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"SyncIndividual",
"in":"body",
"description":"The request body contains details about the synchronization definition.",
"required":true,
"schema":{
"title":"SyncIndividual",
"description":"The request body defines the details of the synchronization definition.",
"properties":{
"callbackUrl":{
"title":"callbackUrl",
"description":"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.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"status":{
"$ref":"#/definitions/SyncStatusType"
},
"syncedInstanceUri":{
"title":"syncedInstanceUri",
"description":"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.",
"type":"string"
},
"syncEndedAt":{
"format":"date-time",
"title":"syncEndedAt",
"description":"The date and time the sync ended. This is a read-only property.",
"type":"string"
},
"syncStartedAt":{
"format":"date-time",
"title":"syncStartedAt",
"description":"The date and time the sync started. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"SyncIndividualResponse",
"description":"The response body includes information about the synchronization definition.",
"properties":{
"callbackUrl":{
"title":"callbackUrl",
"description":"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.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"status":{
"$ref":"#/definitions/SyncStatusType"
},
"syncedInstanceUri":{
"title":"syncedInstanceUri",
"description":"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.",
"type":"string"
},
"syncEndedAt":{
"format":"date-time",
"title":"syncEndedAt",
"description":"The date and time the sync ended. This is a read-only property.",
"type":"string"
},
"syncStartedAt":{
"format":"date-time",
"title":"syncStartedAt",
"description":"The date and time the sync started. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-syncs-post",
"x-filename-id":"api-bulk-2.0-syncs-post"
}
},
"/api/bulk/2.0/syncs/{id}":{
"get":{
"tags":[
"Bulk/2.0/syncs"
],
"summary":"Retrieve a sync",
"description":"Retrieves a sync.",
"operationId":"GetSyncIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the sync.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"SyncIndividualResponse",
"description":"The response body includes information about the synchronization definition.",
"properties":{
"callbackUrl":{
"title":"callbackUrl",
"description":"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.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"status":{
"$ref":"#/definitions/SyncStatusType"
},
"syncedInstanceUri":{
"title":"syncedInstanceUri",
"description":"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.",
"type":"string"
},
"syncEndedAt":{
"format":"date-time",
"title":"syncEndedAt",
"description":"The date and time the sync ended. This is a read-only property.",
"type":"string"
},
"syncStartedAt":{
"format":"date-time",
"title":"syncStartedAt",
"description":"The date and time the sync started. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-syncs-{id}-get",
"x-filename-id":"api-bulk-2.0-syncs-id-get"
}
},
"/api/bulk/2.0/syncs/{id}/data":{
"get":{
"tags":[
"Bulk/2.0/syncs"
],
"summary":"Retrieve an export sync's data",
"description":"Retrieves an export sync's data. This endpoint allows you to retrieve data from an export that you have sync'd more than once. This endpoint will not return any information for import syncs: if the specified sync is an import Eloqua will return a 400 HTTP error code.",
"operationId":"GetSyncDataQuery",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the sync.",
"required":true,
"type":"integer"
},
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"totalResults",
"in":"query",
"description":"Total number of sync results found.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"title":"SyncDataQueryResponse",
"description":"The response body includes information about the synchronization definition.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"type":"object"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-syncs-{id}-data-get",
"x-filename-id":"api-bulk-2.0-syncs-id-data-get"
},
"delete":{
"tags":[
"Bulk/2.0/syncs"
],
"summary":"Delete sync data",
"description":"Deletes sync data for the sync specified by the id parameter.",
"operationId":"DeleteSyncDataQuery",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the sync.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-syncs-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-syncs-id-data-delete"
}
},
"/api/bulk/2.0/syncs/{id}/logs":{
"get":{
"tags":[
"Bulk/2.0/syncs"
],
"summary":"Retrieve a sync's logs",
"description":"Retrieves a sync's logs.",
"operationId":"GetSyncLogSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the sync.",
"required":true,
"type":"integer"
},
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"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.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"SyncLogSearchResponse",
"description":"The response body contains information about a synchronization definition.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncLog"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-syncs-{id}-logs-get",
"x-filename-id":"api-bulk-2.0-syncs-id-logs-get"
}
},
"/api/bulk/2.0/syncs/{id}/rejects":{
"get":{
"tags":[
"Bulk/2.0/syncs"
],
"summary":"Retrieve import sync failure data",
"description":"Retrieves the rejected records for the specified import sync.",
"operationId":"GetSyncRejectSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the sync.",
"required":true,
"type":"integer"
},
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"SyncRejectSearchResponse",
"description":"The response body contains information about the rejected records for the import synchronization.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"List of rejected records, with detail on each rejected record, including message, statusCode, recordIndex, and invalidFields.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncReject"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-syncs-{id}-rejects-get",
"x-filename-id":"api-bulk-2.0-syncs-id-rejects-get"
}
},
"/api/rest/1.0/assets/email":{
"post":{
"operationId":"CreateIndividualPOSTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the email to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/EmailRest10"
}
}
],
"summary":"Create an email",
"description":"Creates an email that matches the criteria specified by the request body for htmlContent with a type of RawHtmlContent.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/EmailRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Emails"
],
"x-internal-id":"api-rest-1.0-assets-email-post",
"x-filename-id":"api-rest-1.0-assets-email-post"
}
},
"/api/rest/1.0/assets/email/{id}":{
"put":{
"operationId":"UpdateIndividualPUTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the email to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/EmailRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the email.",
"required":true,
"type":"integer"
}
],
"summary":"Update an email",
"description":"Updates the email specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/EmailRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Emails"
],
"x-internal-id":"api-rest-1.0-assets-email-{id}-put",
"x-filename-id":"api-rest-1.0-assets-email-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the email.",
"required":true,
"type":"integer"
}
],
"summary":"Delete an email",
"description":"Deletes the email specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Emails"
],
"x-internal-id":"api-rest-1.0-assets-email-{id}-delete",
"x-filename-id":"api-rest-1.0-assets-email-id-delete"
},
"get":{
"operationId":"ReadIndividualGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the email.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve an email",
"description":"Retrieves the email specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/EmailRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Emails"
],
"x-internal-id":"api-rest-1.0-assets-email-{id}-get",
"x-filename-id":"api-rest-1.0-assets-email-id-get"
}
},
"/api/rest/1.0/assets/emails":{
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of emails",
"description":"Retrieves all emails that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultEmailRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Emails"
],
"x-internal-id":"api-rest-1.0-assets-emails-get",
"x-filename-id":"api-rest-1.0-assets-emails-get"
}
},
"/api/rest/2.0/assets/campaign/field":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the campaign field to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/CampaignFieldRest20"
}
}
],
"summary":"Create a campaign field.",
"description":"Creates a campaign field that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/CampaignFieldRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaign fields"
],
"x-internal-id":"api-rest-2.0-assets-campaign-field-post",
"x-filename-id":"api-rest-2.0-assets-campaign-field-post"
}
},
"/api/rest/2.0/assets/campaign/field/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the campaign field to be retrieved.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"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>.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a campaign field.",
"description":"Retrieves the campaign field specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/CampaignFieldRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaign fields"
],
"x-internal-id":"api-rest-2.0-assets-campaign-field-{id}-get",
"x-filename-id":"api-rest-2.0-assets-campaign-field-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The details of the campaign field to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/CampaignFieldRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the campaign field to be updated.",
"required":true,
"type":"integer"
}
],
"summary":"Update a Campaign field.",
"description":"Updates the campaign field specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/CampaignFieldRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaign fields"
],
"x-internal-id":"api-rest-2.0-assets-campaign-field-{id}-put",
"x-filename-id":"api-rest-2.0-assets-campaign-field-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the campaign field to delete.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a campaign field.",
"description":"Deletes the campaign field specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaign fields"
],
"x-internal-id":"api-rest-2.0-assets-campaign-field-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-campaign-field-id-delete"
}
},
"/api/rest/2.0/assets/campaign/fields":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. The default value is minimal.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the campaign field was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of campaign fields.",
"description":"Retrieves all campaign fields that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultCampaignFieldRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaign fields"
],
"x-internal-id":"api-rest-2.0-assets-campaign-fields-get",
"x-filename-id":"api-rest-2.0-assets-campaign-fields-get"
}
},
"/API/OData/ActivityDetails/1/Campaign":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/Campaign"
],
"summary":"Get all Campaigns",
"operationId":"Campaign_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Campaigns successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Campaign"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-Campaign-get",
"x-filename-id":"api-odata-activitydetails-1-campaign-get"
}
},
"/API/OData/ActivityDetails/1/Campaign/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/Campaign"
],
"summary":"Get a single Campaign",
"operationId":"Campaign_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"Campaign ID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Campaign was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Campaign"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-Campaign-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-campaign-key-get"
}
},
"/API/OData/ActivityDetails/1/CampaignResponse":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/CampaignResponse"
],
"summary":"Get all Campaign Responses",
"operationId":"CampaignResponse_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/CampaignResponse"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-CampaignResponse-get",
"x-filename-id":"api-odata-activitydetails-1-campaignresponse-get"
}
},
"/API/OData/ActivityDetails/1/CampaignResponse/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/CampaignResponse"
],
"summary":"Get a single Campaign Response",
"operationId":"CampaignResponse_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"CampaignResponseID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/CampaignResponse"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-CampaignResponse-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-campaignresponse-key-get"
}
},
"/API/OData/ActivityDetails/1/Contact":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/Contact"
],
"summary":"Get all Contacts, Label access control is respected",
"operationId":"Contact_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Contacts successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Contact"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-Contact-get",
"x-filename-id":"api-odata-activitydetails-1-contact-get"
}
},
"/API/OData/ActivityDetails/1/Contact/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/Contact"
],
"summary":"Get a single Contact, Label access control is respected",
"operationId":"Contact_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"ContactID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Contact was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Contact"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-Contact-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-contact-key-get"
}
},
"/API/OData/ActivityDetails/1/ContactIntegrationFields":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/ContactIntegrationFields"
],
"summary":"Get Contact Integration Fields for all contacts",
"operationId":"ContactIntegrationFields_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"ContactIntegrationFields successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/ContactIntegrationFields"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-ContactIntegrationFields-get",
"x-filename-id":"api-odata-activitydetails-1-contactintegrationfields-get"
}
},
"/API/OData/ActivityDetails/1/ContactIntegrationFields/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/ContactIntegrationFields"
],
"summary":"Get Contact Integration Fields for a contact",
"operationId":"ContactIntegrationFields_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"Contact ID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"ContactIntegrationFields was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/ContactIntegrationFields"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-ContactIntegrationFields-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-contactintegrationfields-key-get"
}
},
"/API/OData/ActivityDetails/1/Device":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/Device"
],
"summary":"Get all Devices",
"operationId":"Device_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Devices successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Device"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-Device-get",
"x-filename-id":"api-odata-activitydetails-1-device-get"
}
},
"/API/OData/ActivityDetails/1/Device/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/Device"
],
"summary":"Get a single Device",
"operationId":"Device_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"Device ID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Devices was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Device"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-Device-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-device-key-get"
}
},
"/API/OData/ActivityDetails/1/EloquaLinkedAccount":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EloquaLinkedAccount"
],
"summary":"Get Eloqua Linked Accounts",
"operationId":"EloquaLinkedAccount_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EloquaLinkedAccounts successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EloquaLinkedAccount"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EloquaLinkedAccount-get",
"x-filename-id":"api-odata-activitydetails-1-eloqualinkedaccount-get"
}
},
"/API/OData/ActivityDetails/1/EloquaLinkedAccount/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EloquaLinkedAccount"
],
"summary":"Get the Eloqua Linked Account by EloquaLinkedAccountID",
"operationId":"EloquaLinkedAccount_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"EloquaLinkedAccountID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EloquaLinkedAccount was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EloquaLinkedAccount"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EloquaLinkedAccount-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-eloqualinkedaccount-key-get"
}
},
"/API/OData/ActivityDetails/1/EmailAsset":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailAsset"
],
"summary":"Get all Email Assets",
"operationId":"EmailAsset_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailAssets successfully retrieve",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailAsset"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailAsset-get",
"x-filename-id":"api-odata-activitydetails-1-emailasset-get"
}
},
"/API/OData/ActivityDetails/1/EmailAsset/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailAsset"
],
"summary":"Get a single Email Asset",
"operationId":"EmailAsset_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"EmailAsset ID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailAsset was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailAsset"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailAsset-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-emailasset-key-get"
}
},
"/API/OData/ActivityDetails/1/EmailAutoClick":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailAutoClick"
],
"summary":"Get all Email Auto Clicks",
"operationId":"EmailAutoClick_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailAutoClicks successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailAutoClick"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailAutoClick-get",
"x-filename-id":"api-odata-activitydetails-1-emailautoclick-get"
}
},
"/API/OData/ActivityDetails/1/EmailAutoClick/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailAutoClick"
],
"summary":"Get a single Email Auto Click",
"operationId":"EmailAutoClick_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"EmailAutoClickID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailAutoClicks was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailAutoClick"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailAutoClick-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-emailautoclick-key-get"
}
},
"/API/OData/ActivityDetails/1/EmailAutoOpen":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailAutoOpen"
],
"summary":"Get all Email Auto Opens",
"operationId":"EmailAutoOpen_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailAutoOpens successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailAutoOpen"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailAutoOpen-get",
"x-filename-id":"api-odata-activitydetails-1-emailautoopen-get"
}
},
"/API/OData/ActivityDetails/1/EmailAutoOpen/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailAutoOpen"
],
"summary":"Get a single Email Auto Open",
"operationId":"EmailAutoOpen_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"EmailAutoOpenID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailAutoOpens was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailAutoOpen"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailAutoOpen-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-emailautoopen-key-get"
}
},
"/API/OData/ActivityDetails/1/EmailBounceback":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailBounceback"
],
"summary":"Get all Email Bouncebacks",
"operationId":"EmailBounceback_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailBouncebacks successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailBounceback"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailBounceback-get",
"x-filename-id":"api-odata-activitydetails-1-emailbounceback-get"
}
},
"/API/OData/ActivityDetails/1/EmailBounceback/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailBounceback"
],
"summary":"Get a single Email Bounceback",
"operationId":"EmailBounceback_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"EmailBouncebackID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailBounceback was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailBounceback"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailBounceback-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-emailbounceback-key-get"
}
},
"/API/OData/ActivityDetails/1/EmailClickthrough":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailClickthrough"
],
"summary":"Get all Email Clickthroughs",
"operationId":"EmailClickthrough_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailClickthroughs successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailClickthrough"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailClickthrough-get",
"x-filename-id":"api-odata-activitydetails-1-emailclickthrough-get"
}
},
"/API/OData/ActivityDetails/1/EmailClickthrough/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailClickthrough"
],
"summary":"Get a single Email Clickthrough",
"operationId":"EmailClickthrough_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"EmailClickthroughID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailClickthrough was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailClickthrough"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailClickthrough-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-emailclickthrough-key-get"
}
},
"/API/OData/ActivityDetails/1/EmailGroup":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailGroup"
],
"summary":"Get all Email Groups",
"operationId":"EmailGroup_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Email groups successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailGrp"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailGroup-get",
"x-filename-id":"api-odata-activitydetails-1-emailgroup-get"
}
},
"/API/OData/ActivityDetails/1/EmailGroup/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailGroup"
],
"summary":"Get a single Email Group",
"operationId":"EmailGroup_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"EmailGroupID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Email Group was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailGrp"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailGroup-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-emailgroup-key-get"
}
},
"/API/OData/ActivityDetails/1/EmailGroupSubscriptionStatus":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailGroupSubscriptionStatus"
],
"summary":"Get all Email Group Subscription status",
"operationId":"EmailGroupSubscriptionStatus_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Email group subscriptions Status successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailGroupSubscriptionStatus"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailGroupSubscriptionStatus-get",
"x-filename-id":"api-odata-activitydetails-1-emailgroupsubscriptionstatus-get"
}
},
"/API/OData/ActivityDetails/1/EmailOpen":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailOpen"
],
"summary":"Get all Email Opens",
"operationId":"EmailOpen_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailOpens successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailOpen"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailOpen-get",
"x-filename-id":"api-odata-activitydetails-1-emailopen-get"
}
},
"/API/OData/ActivityDetails/1/EmailOpen/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailOpen"
],
"summary":"Get a single Email Open",
"operationId":"EmailOpen_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"EmailOpenID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailOpen was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailOpen"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailOpen-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-emailopen-key-get"
}
},
"/API/OData/ActivityDetails/1/EmailSend":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailSend"
],
"summary":"Get all Email Sends",
"operationId":"EmailSend_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailSends successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailSend"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailSend-get",
"x-filename-id":"api-odata-activitydetails-1-emailsend-get"
}
},
"/API/OData/ActivityDetails/1/EmailSend/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailSend"
],
"summary":"Get a single Email Send",
"operationId":"EmailSend_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"EmailSendID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailSend was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailSend"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailSend-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-emailsend-key-get"
}
},
"/API/OData/ActivityDetails/1/EmailUnsubscribe":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailUnsubscribe"
],
"summary":"Retrieves all Email Unsubscribes",
"operationId":"EmailUnsubscribe_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailUnsubscribes successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailUnsubscribe"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailUnsubscribe-get",
"x-filename-id":"api-odata-activitydetails-1-emailunsubscribe-get"
}
},
"/API/OData/ActivityDetails/1/EmailUnsubscribe/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/EmailUnsubscribe"
],
"summary":"Get a single Email Unsubscribe",
"operationId":"EmailUnsubscribe_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"EmailUnsubscribeID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailUnsubscribes was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailUnsubscribe"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-EmailUnsubscribe-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-emailunsubscribe-key-get"
}
},
"/API/OData/ActivityDetails/1/FormSubmission":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/FormSubmission"
],
"summary":"Get all Form Submissions",
"operationId":"FormSubmission_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"FormSubmissions successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/FormSubmission"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-FormSubmission-get",
"x-filename-id":"api-odata-activitydetails-1-formsubmission-get"
}
},
"/API/OData/ActivityDetails/1/FormSubmission/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/FormSubmission"
],
"summary":"Get a single Form Submission",
"operationId":"FormSubmission_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"FormSubmissionID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"FormSubmission was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/FormSubmission"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-FormSubmission-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-formsubmission-key-get"
}
},
"/API/OData/ActivityDetails/1/LandingPageVisit":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/LandingPageVisit"
],
"summary":"Get all Landing Page Activities",
"operationId":"LandingPageVisit_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Landing Page Activity successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/LandingPageVisit"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-LandingPageVisit-get",
"x-filename-id":"api-odata-activitydetails-1-landingpagevisit-get"
}
},
"/API/OData/ActivityDetails/1/LandingPageVisit/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/LandingPageVisit"
],
"summary":"Get a single Landing Page Activity",
"operationId":"LandingPageActivity_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"LandingPageActivityID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"LandingPageActivity was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/LandingPageVisit"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-LandingPageVisit-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-landingpagevisit-key-get"
}
},
"/API/OData/ActivityDetails/1/Referrer":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/Referrer"
],
"summary":"Get all Referrers",
"operationId":"Referrer_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Referrers successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Referrer"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-Referrer-get",
"x-filename-id":"api-odata-activitydetails-1-referrer-get"
}
},
"/API/OData/ActivityDetails/1/Referrer/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/Referrer"
],
"summary":"Get a single Referrer",
"operationId":"Referrer_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"ReferrerID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Referrer was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Referrer"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-Referrer-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-referrer-key-get"
}
},
"/API/OData/ActivityDetails/1/Segment":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/Segment"
],
"summary":"Get all Segments",
"operationId":"Segment_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Segments successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Segment"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-Segment-get",
"x-filename-id":"api-odata-activitydetails-1-segment-get"
}
},
"/API/OData/ActivityDetails/1/Segment/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/Segment"
],
"summary":"Get a single Segment",
"operationId":"Segment_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"SegmentID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Segment was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Segment"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-Segment-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-segment-key-get"
}
},
"/API/OData/ActivityDetails/1/SpamUnsubscribesByEmail":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/SpamUnsubscribesByEmail"
],
"summary":"Get all Spam Unsubscribes By Emails",
"operationId":"SpamUnsubscribesByEmail_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"SpamUnsubscribesByEmails successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/SpamUnsubscribesByEmail"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-SpamUnsubscribesByEmail-get",
"x-filename-id":"api-odata-activitydetails-1-spamunsubscribesbyemail-get"
}
},
"/API/OData/ActivityDetails/1/SpamUnsubscribesByEmail/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/SpamUnsubscribesByEmail"
],
"summary":"Get a single Spam Unsubscribe By Email",
"operationId":"SpamUnsubscribesByEmail_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"SpamUnsubscribesByEmailID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"SpamUnsubscribesByEmail was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/SpamUnsubscribesByEmail"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-SpamUnsubscribesByEmail-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-spamunsubscribesbyemail-key-get"
}
},
"/API/OData/ActivityDetails/1/User":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/User"
],
"summary":"Get all Users",
"operationId":"User_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Users successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/User"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-User-get",
"x-filename-id":"api-odata-activitydetails-1-user-get"
}
},
"/API/OData/ActivityDetails/1/User/{key}":{
"get":{
"tags":[
"Reporting/ActivityDetails/1.0/User"
],
"summary":"Get a single User",
"operationId":"User_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"UserID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"User was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/User"
}
}
}
},
"x-internal-id":"API-OData-ActivityDetails-1-User-{key}-get",
"x-filename-id":"api-odata-activitydetails-1-user-key-get"
}
},
"/api/rest/2.0/assets/eventRegistration":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the event to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/EventRegistrationRest20"
}
}
],
"summary":"Create an event",
"description":"Creates an event that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/EventRegistrationRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Events"
],
"x-internal-id":"api-rest-2.0-assets-eventRegistration-post",
"x-filename-id":"api-rest-2.0-assets-eventregistration-post"
}
},
"/api/rest/2.0/assets/eventRegistration/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the event.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve an event",
"description":"Retrieves the event specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/EventRegistrationRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Events"
],
"x-internal-id":"api-rest-2.0-assets-eventRegistration-{id}-get",
"x-filename-id":"api-rest-2.0-assets-eventregistration-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the event to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/EventRegistrationRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the event.",
"required":true,
"type":"integer"
}
],
"summary":"Update an event",
"description":"Updates the event specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/EventRegistrationRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Events"
],
"x-internal-id":"api-rest-2.0-assets-eventRegistration-{id}-put",
"x-filename-id":"api-rest-2.0-assets-eventregistration-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the event.",
"required":true,
"type":"integer"
}
],
"summary":"Delete an event",
"description":"Deletes the event specified by the id parameter.",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Events"
],
"x-internal-id":"api-rest-2.0-assets-eventRegistration-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-eventregistration-id-delete"
}
},
"/api/rest/2.0/assets/eventRegistrations":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"Unix timestamp for the date and time the event was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of events",
"description":"Retrieves all events that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultEventRegistrationRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Events"
],
"x-internal-id":"api-rest-2.0-assets-eventRegistrations-get",
"x-filename-id":"api-rest-2.0-assets-eventregistrations-get"
}
},
"/api/rest/2.0/assets/external/type":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the external asset type to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/ExternalAssetTypeRest20"
}
}
],
"summary":"Create an external asset type",
"description":"Creates an external asset type that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/ExternalAssetTypeRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. This name is used by another external asset type."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/External asset types"
],
"x-internal-id":"api-rest-2.0-assets-external-type-post",
"x-filename-id":"api-rest-2.0-assets-external-type-post"
}
},
"/api/rest/2.0/assets/external/type/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the external asset type to retrieve.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve an external asset type",
"description":"Retrieves the external asset type specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/ExternalAssetTypeRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/External asset types"
],
"x-internal-id":"api-rest-2.0-assets-external-type-{id}-get",
"x-filename-id":"api-rest-2.0-assets-external-type-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the external asset type to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/ExternalAssetTypeRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the external asset type to update.",
"required":true,
"type":"integer"
}
],
"summary":"Update an external asset type",
"description":"Updates the external asset type specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/ExternalAssetTypeRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. This name is used by another external asset type."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/External asset types"
],
"x-internal-id":"api-rest-2.0-assets-external-type-{id}-put",
"x-filename-id":"api-rest-2.0-assets-external-type-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the external asset type.",
"required":true,
"type":"integer"
}
],
"summary":"Delete an external asset type",
"description":"Deletes the external asset type specified by the id parameter.",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/External asset types"
],
"x-internal-id":"api-rest-2.0-assets-external-type-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-external-type-id-delete"
}
},
"/api/rest/2.0/assets/external/types":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"Unix timestamp for the date and time the external asset was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of external asset types",
"description":"Retrieves all external assets type that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultExternalAssetTypeRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/External asset types"
],
"x-internal-id":"api-rest-2.0-assets-external-types-get",
"x-filename-id":"api-rest-2.0-assets-external-types-get"
}
},
"/api/rest/2.0/assets/image/folder":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the folder to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest20"
}
}
],
"summary":"Create a folder",
"description":"Creates a folder that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Image folders"
],
"x-internal-id":"api-rest-2.0-assets-image-folder-post",
"x-filename-id":"api-rest-2.0-assets-image-folder-post"
}
},
"/api/rest/2.0/assets/image/folder/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a folder",
"description":"Retrieves the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Image folders"
],
"x-internal-id":"api-rest-2.0-assets-image-folder-{id}-get",
"x-filename-id":"api-rest-2.0-assets-image-folder-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the folder to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
}
],
"summary":"Update a folder",
"description":"The request body defines the details of the folder to be updated.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Image folders"
],
"x-internal-id":"api-rest-2.0-assets-image-folder-{id}-put",
"x-filename-id":"api-rest-2.0-assets-image-folder-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a folder",
"description":"Deletes the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Image folders"
],
"x-internal-id":"api-rest-2.0-assets-image-folder-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-image-folder-id-delete"
}
},
"/api/rest/2.0/assets/image/folders":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of folders",
"description":"Retrieves all folders that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Image folders"
],
"x-internal-id":"api-rest-2.0-assets-image-folders-get",
"x-filename-id":"api-rest-2.0-assets-image-folders-get"
}
},
"/api/rest/2.0/assets/image/folder/{id}/contents":{
"get":{
"operationId":"SearchContentsGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of folder contents",
"description":"Retrieves all folder contents that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContractObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Image folders"
],
"x-internal-id":"api-rest-2.0-assets-image-folder-{id}-contents-get",
"x-filename-id":"api-rest-2.0-assets-image-folder-id-contents-get"
},
"patch":{
"operationId":"BatchMovePATCHRest20",
"parameters":[
{
"name":"contents",
"in":"body",
"description":"The contents to place in the folder.",
"required":true,
"items":{
"$ref":"#/definitions/MinimalRest20"
},
"schema":{
"type":"array"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
}
],
"summary":"Add content to a folder",
"description":"Places all content into the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/MinimalRest20"
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Image folders"
],
"x-internal-id":"api-rest-2.0-assets-image-folder-{id}-contents-patch",
"x-filename-id":"api-rest-2.0-assets-image-folder-id-contents-patch"
}
},
"/api/rest/2.0/assets/image/folder/root/contents":{
"get":{
"operationId":"SearchRootContentsGETRest20",
"parameters":[
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of folder contents in the root folder",
"description":"Retrieves all folder contents in the root folder that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContractObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Image folders"
],
"x-internal-id":"api-rest-2.0-assets-image-folder-root-contents-get",
"x-filename-id":"api-rest-2.0-assets-image-folder-root-contents-get"
}
},
"/api/rest/2.0/assets/image/folder/root":{
"get":{
"operationId":"ReadRootFolderGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve the root folder",
"description":"Retrieves the root folder.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Image folders"
],
"x-internal-id":"api-rest-2.0-assets-image-folder-root-get",
"x-filename-id":"api-rest-2.0-assets-image-folder-root-get"
}
},
"/api/rest/2.0/assets/image/folder/root/folders":{
"get":{
"operationId":"SearchRootSubFoldersGETRest20",
"parameters":[
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of subfolders in the root folder",
"description":"Retrieves all subfolders in the root folder that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Image folders"
],
"x-internal-id":"api-rest-2.0-assets-image-folder-root-folders-get",
"x-filename-id":"api-rest-2.0-assets-image-folder-root-folders-get"
}
},
"/api/rest/2.0/assets/image/folder/{id}/folders":{
"get":{
"operationId":"SearchSubFoldersGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of subfolders",
"description":"Retrieves all subfolders that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Image folders"
],
"x-internal-id":"api-rest-2.0-assets-image-folder-{id}-folders-get",
"x-filename-id":"api-rest-2.0-assets-image-folder-id-folders-get"
}
},
"/api/rest/1.0/assets/email/folder":{
"post":{
"operationId":"CreateIndividualPOSTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the email folder to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest10"
}
}
],
"summary":"Create an email folder",
"description":"Creates an email folder that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/FolderRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email folders"
],
"x-internal-id":"api-rest-1.0-assets-email-folder-post",
"x-filename-id":"api-rest-1.0-assets-email-folder-post"
}
},
"/api/rest/1.0/assets/email/folder/{id}":{
"get":{
"operationId":"ReadIndividualGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the email folder to retrieve.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve an email folder",
"description":"Retrieves the email folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/FolderRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email folders"
],
"x-internal-id":"api-rest-1.0-assets-email-folder-{id}-get",
"x-filename-id":"api-rest-1.0-assets-email-folder-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the email folder to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the email folder to update.",
"required":true,
"type":"integer"
}
],
"summary":"Update an email folder",
"description":"Updates the email folder specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/FolderRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email folders"
],
"x-internal-id":"api-rest-1.0-assets-email-folder-{id}-put",
"x-filename-id":"api-rest-1.0-assets-email-folder-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the email folder to delete.",
"required":true,
"type":"integer"
}
],
"summary":"Delete an email folder",
"description":"Deletes the email folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email folders"
],
"x-internal-id":"api-rest-1.0-assets-email-folder-{id}-delete",
"x-filename-id":"api-rest-1.0-assets-email-folder-id-delete"
}
},
"/api/rest/1.0/assets/email/folders":{
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"When the email folder was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of email folders",
"description":"Retrieves all email folders that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email folders"
],
"x-internal-id":"api-rest-1.0-assets-email-folders-get",
"x-filename-id":"api-rest-1.0-assets-email-folders-get"
}
},
"/api/rest/2.0/assets/email/deployment":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the email deployment to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/EmailDeploymentRest20"
}
},
{
"name":"preMerge",
"in":"query",
"description":"Whether or not the email header and footer is inserted into the email body. If true, the email header and footer will not be inserted into the email body. If false, the email header and footer will be inserted into the email body. ",
"required":false,
"type":"boolean"
}
],
"summary":"Create and send an email deployment",
"description":"Sends an email to a single contact or a low volume of contacts (up to 100 contacts). See Email deployment API in the Oracle Eloqua Developer Help Center for complete information about this endpoint. Email properties cannot be modified via this endpoint.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/EmailDeploymentRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Email deployment"
],
"x-internal-id":"api-rest-2.0-assets-email-deployment-post",
"x-filename-id":"api-rest-2.0-assets-email-deployment-post"
}
},
"/api/rest/2.0/assets/email/deployment/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the email deployment.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth. Any other values passed are reset to complete by default.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve an email deployment",
"description":"Retrieves information about an email deployment.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/EmailDeploymentRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Email deployment"
],
"x-internal-id":"api-rest-2.0-assets-email-deployment-{id}-get",
"x-filename-id":"api-rest-2.0-assets-email-deployment-id-get"
}
},
"/api/bulk/2.0/contacts/exports":{
"get":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Retrieve a list of contact export definitions",
"description":"Retrieves a list of contact export definitions.",
"operationId":"GetContactExportSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ContactExportSearchResponse",
"description":"The response body contains information about the contact export definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/Export"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-exports-get",
"x-filename-id":"api-bulk-2.0-contacts-exports-get"
},
"post":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Create a contact export definition",
"description":"Creates a new contact export definition. See the tutorial for details on how to export data.",
"operationId":"PostContactExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"ContactExportIndividual",
"in":"body",
"description":"The request body contains details of the contact export definition.",
"required":true,
"schema":{
"title":"ContactExportIndividual",
"description":"The request body defines details of the contact export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"ContactExportIndividualResponse",
"description":"The response body contains information about the contact export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-exports-post",
"x-filename-id":"api-bulk-2.0-contacts-exports-post"
}
},
"/api/bulk/2.0/contacts/exports/{id}":{
"get":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Retrieve a contact export definition",
"description":"Retrieves a contact export definition.",
"operationId":"GetContactExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the contact export.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ContactExportIndividualResponse",
"description":"The response body contains information about the contact export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-exports-{id}-get",
"x-filename-id":"api-bulk-2.0-contacts-exports-id-get"
},
"put":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Update a contact export definition",
"description":"Updates a contact export definition.",
"operationId":"PutContactExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the contact export.",
"required":true,
"type":"integer"
},
{
"name":"ContactExportIndividual",
"in":"body",
"description":"The request body contains details of the contact export definition.",
"required":true,
"schema":{
"title":"ContactExportIndividual",
"description":"The request body defines details of the contact export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ContactExportIndividualResponse",
"description":"The response body contains information about the contact export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-exports-{id}-put",
"x-filename-id":"api-bulk-2.0-contacts-exports-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Delete a contact export definition",
"description":"Deletes a contact export definition.",
"operationId":"DeleteContactExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the contact export.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-exports-{id}-delete",
"x-filename-id":"api-bulk-2.0-contacts-exports-id-delete"
}
},
"/api/bulk/2.0/contacts/exports/{id}/data":{
"get":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Retrieve a contact export definition's synced data",
"description":"Retrieves a contact export definition's synced data.",
"operationId":"GetContactExportDataQuery",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the contact export.",
"required":true,
"type":"integer"
},
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ContactExportDataQueryResponse",
"description":"Query response when retrieving contact export data.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items returned.",
"type":"array",
"items":{
"type":"object"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-exports-{id}-data-get",
"x-filename-id":"api-bulk-2.0-contacts-exports-id-data-get"
},
"delete":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Delete a contact export definition's data",
"description":"Deletes a contact export definition's data.",
"operationId":"DeleteContactExportDataQuery",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the contact export.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-exports-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-contacts-exports-id-data-delete"
}
},
"/api/bulk/2.0/contacts/fields/{id}":{
"get":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Retrieve a contact field definition",
"description":"Retrieves a contact field definition.",
"operationId":"GetContactFieldIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the contact field.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ContactFieldIndividualResponse",
"description":"The response body contains information about the contact field definition.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataType":{
"$ref":"#/definitions/DataType"
},
"defaultValue":{
"title":"defaultValue",
"description":"The contact field's default value.",
"type":"string"
},
"hasNotNullConstraint":{
"title":"hasNotNullConstraint",
"description":"Indicates whether the field can have null values (i.e. empty).",
"type":"boolean"
},
"hasReadOnlyConstraint":{
"title":"hasReadOnlyConstraint",
"description":"Indicates whether the field can be written to.",
"type":"boolean"
},
"hasUniquenessConstraint":{
"title":"hasUniquenessConstraint",
"description":"Indicates whether the field must have a unique value.",
"type":"boolean"
},
"internalName":{
"title":"internalName",
"description":"The field's internal name (used to uniquely identify it).",
"type":"string"
},
"name":{
"title":"name",
"description":"The contact field's name.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-fields-{id}-get",
"x-filename-id":"api-bulk-2.0-contacts-fields-id-get"
}
},
"/api/bulk/2.0/contacts/fields":{
"get":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Retrieve a list of contact field definitions",
"description":"Retrieves a list of contact field definitions.",
"operationId":"GetContactFieldSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ContactFieldSearchResponse",
"description":"The response body contains information about the contact export definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/ContactField"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-fields-get",
"x-filename-id":"api-bulk-2.0-contacts-fields-get"
}
},
"/api/bulk/2.0/contacts/filters/{id}":{
"get":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Retrieve a contact filter",
"description":"Retrieves a contact filter that matches the criteria specified in the URL parameters.",
"operationId":"GetContactFilterIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Number of results returned in the request.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ContactFilterIndividualResponse",
"description":"Indicates if there are more results.",
"properties":{
"count":{
"title":"count",
"description":"The number of items returned.\r\n\r\nIn items: the number of records operated on for that message.",
"type":"integer"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the contact filter was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the contact filter field. This is a read-only property.",
"type":"string"
},
"executedAt":{
"format":"date-time",
"title":"executedAt",
"description":"The time and date the contact filter was last used.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the contact definition.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-filters-{id}-get",
"x-filename-id":"api-bulk-2.0-contacts-filters-id-get"
}
},
"/api/bulk/2.0/contacts/filters":{
"get":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Retrieve a list of contact filters",
"description":"Retrieves a list of contact filters that match the criteria specified in the URL parameters.",
"operationId":"GetContactFilterSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ContactFilterSearchResponse",
"description":"The response body contains information about the contact export definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/ContactFilter"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-filters-get",
"x-filename-id":"api-bulk-2.0-contacts-filters-get"
}
},
"/api/bulk/2.0/contacts/imports":{
"get":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Retrieve a list of contact import definitions",
"description":"Retrieves a list of contact import definitions.",
"operationId":"GetContactImportSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ContactImportSearchResponse",
"description":"The response body contains information about the contact import definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/Import"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-imports-get",
"x-filename-id":"api-bulk-2.0-contacts-imports-get"
},
"post":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Create a contact import definition",
"description":"Creates a new contact import definition. See the tutorial for details on how to import data.",
"operationId":"PostContactImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"ContactImportIndividual",
"in":"body",
"description":"The request body contains details of the contact import definition.",
"required":true,
"schema":{
"title":"ContactImportIndividual",
"description":"The request body defines the details of the contact import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"ContactImportIndividualResponse",
"description":"The response body includes information about the contact import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-imports-post",
"x-filename-id":"api-bulk-2.0-contacts-imports-post"
}
},
"/api/bulk/2.0/contacts/imports/{id}":{
"get":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Retrieve a contact import definition",
"description":"Retrieves an contact import definition.",
"operationId":"GetContactImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the contact import.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ContactImportIndividualResponse",
"description":"The response body includes information about the contact import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-imports-{id}-get",
"x-filename-id":"api-bulk-2.0-contacts-imports-id-get"
},
"put":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Update a contact import definition",
"description":"Updates a contact import definition.",
"operationId":"PutContactImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the contact import.",
"required":true,
"type":"integer"
},
{
"name":"ContactImportIndividual",
"in":"body",
"description":"The request body contains details of the contact import definition.",
"required":true,
"schema":{
"title":"ContactImportIndividual",
"description":"The request body defines the details of the contact import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ContactImportIndividualResponse",
"description":"The response body includes information about the contact import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-imports-{id}-put",
"x-filename-id":"api-bulk-2.0-contacts-imports-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Delete a contact import definition",
"description":"Deletes a contact import definition.",
"operationId":"DeleteContactImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the contact import.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-imports-{id}-delete",
"x-filename-id":"api-bulk-2.0-contacts-imports-id-delete"
}
},
"/api/bulk/2.0/contacts/imports/{id}/data":{
"post":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Upload data for a contact import definition",
"description":"Uploads data for a contact import definition. When uploading data, Eloqua expects that data to be encoded with UTF-8.",
"operationId":"PostContactImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the contact import.",
"required":true,
"type":"integer"
},
{
"name":"ContactImportData",
"in":"body",
"description":"The request body contains data to be uploaded to the contact import definition.",
"required":true,
"schema":{
"title":"ContactImportData",
"type":"array",
"items":{
"title":"ContactImportDataItem",
"type":"object",
"items":{
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"ContactImportDataResponse",
"description":"Sync response when POSTing contact import data, and isSyncTriggeredOnImport = true on the import definition.",
"properties":{
"callbackUrl":{
"title":"callbackUrl",
"description":"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.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"status":{
"$ref":"#/definitions/SyncStatusType"
},
"syncedInstanceUri":{
"title":"syncedInstanceUri",
"description":"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.",
"type":"string"
},
"syncEndedAt":{
"format":"date-time",
"title":"syncEndedAt",
"description":"The date and time the sync ended. This is a read-only property.",
"type":"string"
},
"syncStartedAt":{
"format":"date-time",
"title":"syncStartedAt",
"description":"The date and time the sync started. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"204":{
"description":"No content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-imports-{id}-data-post",
"x-filename-id":"api-bulk-2.0-contacts-imports-id-data-post"
},
"delete":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Delete a contact import definition's data",
"description":"Deletes a contact import definition's data.",
"operationId":"DeleteContactImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the contact import.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-imports-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-contacts-imports-id-data-delete"
}
},
"/api/bulk/2.0/contacts/lists/{id}":{
"get":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Retrieve a contact list",
"description":"Retrieves a contact list.",
"operationId":"GetContactListIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the contact list.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ContactListIndividualResponse",
"description":"The response body contains information about the contact list definition.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"name":{
"title":"name",
"description":"The contact list's name.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the contact list was last updated, expressed using the ISO-8601 standard.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-lists-{id}-get",
"x-filename-id":"api-bulk-2.0-contacts-lists-id-get"
}
},
"/api/bulk/2.0/contacts/lists":{
"get":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Retrieve a list of contact lists",
"description":"Retrieves a list of contact lists.",
"operationId":"GetContactListSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ContactListSearchResponse",
"description":"The response body contains information about the contact list definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/ContactList"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-lists-get",
"x-filename-id":"api-bulk-2.0-contacts-lists-get"
}
},
"/api/bulk/2.0/contacts/scoring/models/{id}":{
"get":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Retrieve a lead scoring model",
"description":"Retrieve a lead scoring model using the lead scoring ID.",
"operationId":"GetLeadScoreModelIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the lead scoring model.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"LeadScoreModelIndividualResponse",
"description":"The response body contains information about the lead score model definition.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"array",
"items":{
"$ref":"#/definitions/StandardLeadScoringModelField"
}
},
"id":{
"title":"id",
"description":"The lead scoring model identifier.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The lead scoring model's name.",
"type":"string"
},
"status":{
"title":"status",
"description":"The status of the lead scoring model.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-scoring-models-{id}-get",
"x-filename-id":"api-bulk-2.0-contacts-scoring-models-id-get"
}
},
"/api/bulk/2.0/contacts/scoring/models":{
"get":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Retrieve a list of lead scoring models",
"description":"Retrieves a list of lead scoring models. Lead scoring fields are read only and can only be used in Contact Exports.",
"operationId":"GetLeadScoreModelSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"LeadScoreModelSearchResponse",
"description":"The response body contains information about the lead score model definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/LeadScoreModel"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-scoring-models-get",
"x-filename-id":"api-bulk-2.0-contacts-scoring-models-get"
}
},
"/api/bulk/2.0/contacts/segments/{id}":{
"get":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Retrieve a contact segment",
"description":"Retrieves a contact segment.",
"operationId":"GetContactSegmentIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the contact segment.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ContactSegmentIndividualResponse",
"description":"The response body contains information about the contact segment definition.",
"properties":{
"count":{
"title":"count",
"description":"The number of items returned.\r\n\r\nIn items: the number of records operated on for that message.",
"type":"integer"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the contact segment was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the contact segment. This is a read-only property.",
"type":"string"
},
"executedAt":{
"format":"date-time",
"title":"executedAt",
"description":"The time and date the contact segment was last used.",
"type":"string"
},
"name":{
"title":"name",
"description":"The contact list's name.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the contact segment was last updated, expressed using the ISO-8601 standard.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the contact segment.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-segments-{id}-get",
"x-filename-id":"api-bulk-2.0-contacts-segments-id-get"
}
},
"/api/bulk/2.0/contacts/segments":{
"get":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Retrieve a list of contact segments",
"description":"Retrieves a list of contact segments.",
"operationId":"GetContactSegmentSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ContactSegmentSearchResponse",
"description":"The response body contains information about the contact segment definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/ContactSegment"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-segments-get",
"x-filename-id":"api-bulk-2.0-contacts-segments-get"
}
},
"/api/bulk/2.0/contacts/syncActions":{
"get":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Retrieve a list of contact sync action definitions",
"description":"Retrieves a list of contact sync action definitions.",
"operationId":"GetContactSyncActionOperationSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ContactSyncActionOperationSearchResponse",
"description":"The response body contains information about the contact sync action definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncActionOperation"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-syncActions-get",
"x-filename-id":"api-bulk-2.0-contacts-syncactions-get"
},
"post":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Create a contact sync action definition",
"description":"Creates a new contact sync action definition.",
"operationId":"PostContactSyncActionOperationIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"ContactSyncActionOperationIndividual",
"in":"body",
"description":"The request body contains details of the contact sync action definition.",
"required":true,
"schema":{
"title":"ContactSyncActionOperationIndividual",
"description":"The request body defines details of the contact sync action definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the sync action. This is a read-only property.",
"type":"string"
},
"fields":{
"title":"fields",
"description":"The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field.\r\n\r\nAllowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}.\r\n\r\nAllowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}.\r\n\r\nAllowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered upon uploading data.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kb. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the sync action definition.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. \r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"ContactSyncActionOperationIndividualResponse",
"description":"The response body includes information about the contact sync action definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the sync action. This is a read-only property.",
"type":"string"
},
"fields":{
"title":"fields",
"description":"The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field.\r\n\r\nAllowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}.\r\n\r\nAllowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}.\r\n\r\nAllowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered upon uploading data.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kb. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the sync action definition.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. \r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-syncActions-post",
"x-filename-id":"api-bulk-2.0-contacts-syncactions-post"
}
},
"/api/bulk/2.0/contacts/syncActions/{id}":{
"get":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Retrieve a contact sync action definition",
"description":"Retrieves a contact sync action definition.",
"operationId":"GetContactSyncActionOperationIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The sync action definition's resource identification number. The unique resource identifier (URI) references the id and part of the path, e.g. /contacts/syncActions/635.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ContactSyncActionOperationIndividualResponse",
"description":"The response body includes information about the contact sync action definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the sync action. This is a read-only property.",
"type":"string"
},
"fields":{
"title":"fields",
"description":"The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field.\r\n\r\nAllowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}.\r\n\r\nAllowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}.\r\n\r\nAllowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered upon uploading data.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kb. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the sync action definition.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. \r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-syncActions-{id}-get",
"x-filename-id":"api-bulk-2.0-contacts-syncactions-id-get"
},
"put":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Update a contact sync action definition",
"description":"Updates a contact sync action definition. For PUT requests, the parameters below are required for validation, even if they are not changing.",
"operationId":"PutContactSyncActionOperationIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The sync action definition's resource identification number. The unique resource identifier (URI) references the id and part of the path, e.g. /contacts/syncActions/635.",
"required":true,
"type":"integer"
},
{
"name":"ContactSyncActionOperationIndividual",
"in":"body",
"description":"The request body contains details of the contact sync action definition.",
"required":true,
"schema":{
"title":"ContactSyncActionOperationIndividual",
"description":"The request body defines details of the contact sync action definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the sync action. This is a read-only property.",
"type":"string"
},
"fields":{
"title":"fields",
"description":"The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field.\r\n\r\nAllowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}.\r\n\r\nAllowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}.\r\n\r\nAllowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered upon uploading data.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kb. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the sync action definition.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. \r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ContactSyncActionOperationIndividualResponse",
"description":"The response body includes information about the contact sync action definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the sync action. This is a read-only property.",
"type":"string"
},
"fields":{
"title":"fields",
"description":"The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field.\r\n\r\nAllowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}.\r\n\r\nAllowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}.\r\n\r\nAllowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered upon uploading data.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kb. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the sync action definition.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. \r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-syncActions-{id}-put",
"x-filename-id":"api-bulk-2.0-contacts-syncactions-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Delete a contact sync action definition",
"description":"Deletes the specified contact sync action definition.",
"operationId":"DeleteContactSyncActionOperationIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The sync action definition's resource identification number. The unique resource identifier (URI) references the id and part of the path, e.g. /contacts/syncActions/635.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-syncActions-{id}-delete",
"x-filename-id":"api-bulk-2.0-contacts-syncactions-id-delete"
}
},
"/api/bulk/2.0/contacts/syncActions/{id}/data":{
"post":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Upload contact sync action data",
"description":"Uploads contact sync action data.",
"operationId":"PostContactSyncActionOperationData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The sync action definition's resource identification number. The unique resource identifier (URI) references the id and part of the path, e.g. /contacts/syncActions/635.",
"required":true,
"type":"integer"
},
{
"name":"ContactSyncActionOperationData",
"in":"body",
"description":"The request body contains details of the contact sync action data.",
"required":true,
"schema":{
"title":"ContactSyncActionOperationData",
"type":"array",
"items":{
"title":"ContactSyncActionOperationDataItem",
"type":"object",
"items":{
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"ContactSyncActionOperationDataResponse",
"description":"Sync response when POSTing contact sync action data, and isSyncTriggeredOnImport = true on the sync action definition.",
"properties":{
"callbackUrl":{
"title":"callbackUrl",
"description":"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.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"status":{
"$ref":"#/definitions/SyncStatusType"
},
"syncedInstanceUri":{
"title":"syncedInstanceUri",
"description":"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.",
"type":"string"
},
"syncEndedAt":{
"format":"date-time",
"title":"syncEndedAt",
"description":"The date and time the sync ended. This is a read-only property.",
"type":"string"
},
"syncStartedAt":{
"format":"date-time",
"title":"syncStartedAt",
"description":"The date and time the sync started. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"204":{
"description":"No content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-syncActions-{id}-data-post",
"x-filename-id":"api-bulk-2.0-contacts-syncactions-id-data-post"
},
"delete":{
"tags":[
"Bulk/2.0/contacts"
],
"summary":"Delete sync data for a contact sync action definition",
"description":"Deletes sync data for a contact sync action definition.",
"operationId":"DeleteContactSyncActionOperationData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The sync action definition's resource identification number. The unique resource identifier (URI) references the id and part of the path, e.g. /contacts/syncActions/635.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-contacts-syncActions-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-contacts-syncactions-id-data-delete"
}
},
"/api/rest/2.0/assets/visitor/fields":{
"get":{
"operationId":"GetVisitorProfileFieldsGETRest20",
"parameters":[
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of visitor profile fields",
"description":"Retrieves a list of visitor profile fields",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultProfileFieldRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Visitor profile fields"
],
"x-internal-id":"api-rest-2.0-assets-visitor-fields-get",
"x-filename-id":"api-rest-2.0-assets-visitor-fields-get"
}
},
"/api/rest/1.0/assets/customObject":{
"post":{
"operationId":"CreateIndividualPOSTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the custom object to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/CustomObjectRest10"
}
}
],
"summary":"Create a custom object",
"description":"Creates a custom object that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/CustomObjectRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Custom objects"
],
"x-internal-id":"api-rest-1.0-assets-customObject-post",
"x-filename-id":"api-rest-1.0-assets-customobject-post"
}
},
"/api/rest/1.0/assets/customObject/{id}":{
"get":{
"operationId":"ReadIndividualGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the custom object.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a custom object",
"description":"Retrieves the custom object specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/CustomObjectRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Custom objects"
],
"x-internal-id":"api-rest-1.0-assets-customObject-{id}-get",
"x-filename-id":"api-rest-1.0-assets-customobject-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the custom object to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/CustomObjectRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the custom object.",
"required":true,
"type":"integer"
}
],
"summary":"Update a custom object",
"description":"Updates the custom object specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/CustomObjectRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Custom objects"
],
"x-internal-id":"api-rest-1.0-assets-customObject-{id}-put",
"x-filename-id":"api-rest-1.0-assets-customobject-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the custom object.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a custom object",
"description":"Deletes the custom object specified by the id parameter.",
"responses":{
"204":{
"description":"No matching custom objects were found in the search."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"The custom object you are attempting to delete has dependencies, and cannot be deleted."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Custom objects"
],
"x-internal-id":"api-rest-1.0-assets-customObject-{id}-delete",
"x-filename-id":"api-rest-1.0-assets-customobject-id-delete"
}
},
"/api/rest/1.0/assets/customObjects":{
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the custom object was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of custom objects",
"description":"Retrieves all custom objects that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultCustomObjectRest10"
}
},
"204":{
"description":"No matching custom objects were found in the search."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Custom objects"
],
"x-internal-id":"api-rest-1.0-assets-customObjects-get",
"x-filename-id":"api-rest-1.0-assets-customobjects-get"
}
},
"/api/rest/2.0/data/contact/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the contact",
"required":true,
"type":"string"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"viewId",
"in":"query",
"description":"The user's default contact view identifier. ",
"required":false,
"type":"string"
}
],
"summary":"Retrieves a contact",
"description":"Retrieves the contact specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/ContactRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contacts"
],
"x-internal-id":"api-rest-2.0-data-contact-{id}-get",
"x-filename-id":"api-rest-2.0-data-contact-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the contact to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/ContactRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the contact",
"required":true,
"type":"string"
}
],
"summary":"Update a contact",
"description":"The request body defines the details of the contact to be updated.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/ContactRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contacts"
],
"x-internal-id":"api-rest-2.0-data-contact-{id}-put",
"x-filename-id":"api-rest-2.0-data-contact-id-put"
}
},
"/api/rest/2.0/data/contact/{id}/membership":{
"get":{
"operationId":"ListGroupMembershipGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the contact to retrieve.",
"required":true,
"type":"integer"
}
],
"summary":"Retrieve contact list membership information for a contact",
"description":"Retrieves a list of contact lists that a contact is a member of.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/ContactListRest20"
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contacts"
],
"x-internal-id":"api-rest-2.0-data-contact-{id}-membership-get",
"x-filename-id":"api-rest-2.0-data-contact-id-membership-get"
}
},
"/api/rest/2.0/data/contacts":{
"post":{
"operationId":"SearchContactsSEARCHRest20",
"parameters":[
{
"name":"search",
"in":"body",
"description":"The request body defines the details of the request.",
"required":true,
"schema":{
"$ref":"#/definitions/EntitySearchByIdsRest20"
}
},
{
"name":"X-HTTP-Method-Override",
"in":"header",
"description":"The request header X-HTTP-Method-Override must be set with value SEARCH.",
"required":true,
"type":"string",
"format":"string",
"default":"SEARCH"
}
],
"summary":"Retrieve contact information",
"description":"Retrieves contact information for up to 200 contacts, searched by contact id. Use the depth parameter when making the request to specify the contact information returned in the response.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/ContactRest20"
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contacts"
],
"x-internal-id":"api-rest-2.0-data-contacts-post",
"x-filename-id":"api-rest-2.0-data-contacts-post"
}
},
"/API/OData/FormSubmission/1/Calendar":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/Calendar"
],
"summary":"Get all Calendar records",
"operationId":"Calendar_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Calendars successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Calendar"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-Calendar-get",
"x-filename-id":"api-odata-formsubmission-1-calendar-get"
}
},
"/API/OData/FormSubmission/1/Campaign":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/Campaign"
],
"summary":"Get all Campaigns",
"operationId":"Campaign_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Campaigns successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Campaign"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-Campaign-get",
"x-filename-id":"api-odata-formsubmission-1-campaign-get"
}
},
"/API/OData/FormSubmission/1/Campaign/{key}":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/Campaign"
],
"summary":"Get a single Campaign",
"operationId":"Campaign_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"CampaignID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Campaign was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Campaign"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-Campaign-{key}-get",
"x-filename-id":"api-odata-formsubmission-1-campaign-key-get"
}
},
"/API/OData/FormSubmission/1/Campaign/{key}/FormSubmissionActivities":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/Campaign"
],
"summary":"Get Form Submission activities for a specified Campaign ID",
"operationId":"Campaign_GetFormSubmissionActivities",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"CampaignID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"GetFormSubmissionActivities were successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/FormSubmissionActivities"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-Campaign-{key}-FormSubmissionActivities-get",
"x-filename-id":"api-odata-formsubmission-1-campaign-key-formsubmissionactivities-get"
}
},
"/API/OData/FormSubmission/1/EmailAsset":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/EmailAsset"
],
"summary":"Get all Email Assets",
"operationId":"EmailAsset_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailAssets successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailAsset"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-EmailAsset-get",
"x-filename-id":"api-odata-formsubmission-1-emailasset-get"
}
},
"/API/OData/FormSubmission/1/EmailAsset/{key}":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/EmailAsset"
],
"summary":"Get a single EmailAsset",
"operationId":"EmailAsset_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"EmailAssetID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailAsset was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailAsset"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-EmailAsset-{key}-get",
"x-filename-id":"api-odata-formsubmission-1-emailasset-key-get"
}
},
"/API/OData/FormSubmission/1/EmailAsset/{key}/FormSubmissionActivities":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/EmailAsset"
],
"summary":"Get Form Submission activities for a specified Email Asset",
"operationId":"EmailAsset_GetFormSubmissionActivities",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"EmailAssetID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailActivities were successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/FormSubmissionActivities"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-EmailAsset-{key}-FormSubmissionActivities-get",
"x-filename-id":"api-odata-formsubmission-1-emailasset-key-formsubmissionactivities-get"
}
},
"/API/OData/FormSubmission/1/FormAsset":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/FormAsset"
],
"summary":"Get all Form Assets",
"operationId":"FormAsset_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"FormAssets successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/FormAsset"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-FormAsset-get",
"x-filename-id":"api-odata-formsubmission-1-formasset-get"
}
},
"/API/OData/FormSubmission/1/FormAsset/{key}":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/FormAsset"
],
"summary":"Get a single Form Asset",
"operationId":"FormAsset_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"FormAssetID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"FormAssets were successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/FormAsset"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-FormAsset-{key}-get",
"x-filename-id":"api-odata-formsubmission-1-formasset-key-get"
}
},
"/API/OData/FormSubmission/1/FormSubmissionActivities":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/FormSubmissionActivities"
],
"summary":"Get all Form Submission Activities",
"operationId":"FormSubmissionActivities_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"FormSubmissionActivities successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/FormSubmissionActivities"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-FormSubmissionActivities-get",
"x-filename-id":"api-odata-formsubmission-1-formsubmissionactivities-get"
}
},
"/API/OData/FormSubmission/1/LandingPageAsset":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/LandingPageAsset"
],
"summary":"Get all Landing Page Assets",
"operationId":"LandingPageAsset_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"LandingPageAssets successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/LandingPageAsset"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-LandingPageAsset-get",
"x-filename-id":"api-odata-formsubmission-1-landingpageasset-get"
}
},
"/API/OData/FormSubmission/1/LandingPageAsset/{key}":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/LandingPageAsset"
],
"summary":"Get a single Landing Page Asset",
"operationId":"LandingPageAsset_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"LandingPageAssetsID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"LandingPageAssets was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/LandingPageAsset"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-LandingPageAsset-{key}-get",
"x-filename-id":"api-odata-formsubmission-1-landingpageasset-key-get"
}
},
"/API/OData/FormSubmission/1/LandingPageAsset/{key}/FormSubmissionActivities":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/LandingPageAsset"
],
"summary":"Get Form Submission Activites for a specified Landing Page Asset",
"operationId":"LandingPageAsset_GetFormSubmissionActivities",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"LandingPageAssetID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"FormSubmissionActivities were successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/FormSubmissionActivities"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-LandingPageAsset-{key}-FormSubmissionActivities-get",
"x-filename-id":"api-odata-formsubmission-1-landingpageasset-key-formsubmissionactivities-get"
}
},
"/API/OData/FormSubmission/1/User":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/User"
],
"summary":"Get all Users",
"operationId":"User_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Users successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/User"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-User-get",
"x-filename-id":"api-odata-formsubmission-1-user-get"
}
},
"/API/OData/FormSubmission/1/User/{key}":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/User"
],
"summary":"Get a single User",
"operationId":"User_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"The requested User identifier",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"User was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/User"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-User-{key}-get",
"x-filename-id":"api-odata-formsubmission-1-user-key-get"
}
},
"/API/OData/FormSubmission/1/User/{key}/Campaigns":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/User"
],
"summary":"Get Campaigns for a specified User",
"operationId":"User_GetCampaigns",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"UserID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Campaigns were successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Campaign"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-User-{key}-Campaigns-get",
"x-filename-id":"api-odata-formsubmission-1-user-key-campaigns-get"
}
},
"/API/OData/FormSubmission/1/User/{key}/EmailAssets":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/User"
],
"summary":"Get Email Asset for a specified User",
"operationId":"User_GetEmailAssets",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"UserID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailAssets were successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailAsset"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-User-{key}-EmailAssets-get",
"x-filename-id":"api-odata-formsubmission-1-user-key-emailassets-get"
}
},
"/API/OData/FormSubmission/1/WebPage":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/WebPage"
],
"summary":"Get all Web Pages",
"operationId":"WebPage_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"WebPages successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/WebPage"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-WebPage-get",
"x-filename-id":"api-odata-formsubmission-1-webpage-get"
}
},
"/API/OData/FormSubmission/1/WebPage/{key}":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/WebPage"
],
"summary":"Get a single Web Page",
"operationId":"WebPage_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"WebPageID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"WebPage was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/WebPage"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-WebPage-{key}-get",
"x-filename-id":"api-odata-formsubmission-1-webpage-key-get"
}
},
"/API/OData/FormSubmission/1/WebPage/{key}/FormSubmissionActivities":{
"get":{
"tags":[
"Reporting/FormSubmission/1.0/WebPage"
],
"summary":"Get all Form Submission Activities for a specified web page",
"operationId":"WebPage_GetFormSubmissionActivities",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"WebPageID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/FormSubmissionActivities"
}
}
}
},
"x-internal-id":"API-OData-FormSubmission-1-WebPage-{key}-FormSubmissionActivities-get",
"x-filename-id":"api-odata-formsubmission-1-webpage-key-formsubmissionactivities-get"
}
},
"/api/rest/2.0/data/sms/subscription":{
"put":{
"operationId":"UpdateSubscriptionPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the subscription message to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/PhoneNumberSubscriptionDetailsRest20"
}
}
],
"summary":"Update a subscription",
"description":"Update consent of a phone number.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/PhoneNumberSubscriptionRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS subscription"
],
"x-internal-id":"api-rest-2.0-data-sms-subscription-put",
"x-filename-id":"api-rest-2.0-data-sms-subscription-put"
},
"post":{
"operationId":"SearchSEARCHRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the subscription message to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/PhoneNumberSubscriptionSearchRest20"
}
},
{
"name":"X-HTTP-Method-Override",
"in":"header",
"description":"ISmsSubscriptionService_Parameter_Search_xhttpmethodoverride_Description",
"required":true,
"type":"string",
"format":"string",
"default":"SEARCH"
}
],
"summary":"Retrieve a list of subscription",
"description":"Retrieve consent of a list of phone numbers, a maximum of 10 phone numbers can be passed in a single request.",
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/PhoneNumberSubscriptionRest20"
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/SMS subscription"
],
"x-internal-id":"api-rest-2.0-data-sms-subscription-post",
"x-filename-id":"api-rest-2.0-data-sms-subscription-post"
}
},
"/api/rest/2.0/data/customObject/{parentId}/instance":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the custom object data to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/CustomObjectDataRest20"
}
},
{
"name":"parentId",
"in":"path",
"description":"Id of the parent.",
"required":true,
"type":"integer"
}
],
"summary":"Create custom object data",
"description":"Creates custom object data that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/CustomObjectDataRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Custom object data"
],
"x-internal-id":"api-rest-2.0-data-customObject-{parentId}-instance-post",
"x-filename-id":"api-rest-2.0-data-customobject-parentid-instance-post"
}
},
"/api/rest/2.0/data/customObject/{parentId}/instance/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"Id of the parent.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"Id of the custom object data.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve custom object data",
"description":"Retrieves the data (records) for the custom object specified by the {parentId} and id parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/CustomObjectDataRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Custom object data"
],
"x-internal-id":"api-rest-2.0-data-customObject-{parentId}-instance-{id}-get",
"x-filename-id":"api-rest-2.0-data-customobject-parentid-instance-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the custom object data to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/CustomObjectDataRest20"
}
},
{
"name":"parentId",
"in":"path",
"description":"Id of the parent.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"Id of the custom object data.",
"required":true,
"type":"integer"
}
],
"summary":"Update custom object data",
"description":"Updates custom object data specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/CustomObjectDataRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Custom object data"
],
"x-internal-id":"api-rest-2.0-data-customObject-{parentId}-instance-{id}-put",
"x-filename-id":"api-rest-2.0-data-customobject-parentid-instance-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"Id of the parent.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"Id of the custom object data.",
"required":true,
"type":"integer"
}
],
"summary":"Delete custom object data",
"description":"Deletes custom object data specified by the id parameter.",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Custom object data"
],
"x-internal-id":"api-rest-2.0-data-customObject-{parentId}-instance-{id}-delete",
"x-filename-id":"api-rest-2.0-data-customobject-parentid-instance-id-delete"
}
},
"/api/rest/2.0/data/customObject/{parentId}/instances":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"Id of the parent.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a list of custom object data",
"description":"Retrieves the data (records) for all custom objects that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultCustomObjectDataRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Custom object data"
],
"x-internal-id":"api-rest-2.0-data-customObject-{parentId}-instances-get",
"x-filename-id":"api-rest-2.0-data-customobject-parentid-instances-get"
}
},
"/api/bulk/2.0/emailGroups/{id}":{
"get":{
"tags":[
"Bulk/2.0/emailGroups"
],
"summary":"Retrieve an email group",
"description":"Retrieves an email group.",
"operationId":"GetEmailGroupIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The unique resource identifier of the email group.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"EmailGroupIndividualResponse",
"description":"The response body contains information about the email group definition.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the email address definition.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-emailGroups-{id}-get",
"x-filename-id":"api-bulk-2.0-emailgroups-id-get"
}
},
"/api/bulk/2.0/emailGroups":{
"get":{
"tags":[
"Bulk/2.0/emailGroups"
],
"summary":"Retrieve a list of email groups",
"description":"Retrieves a list of email groups.",
"operationId":"GetEmailGroupSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"EmailGroupSearchResponse",
"description":"The response body contains information about the email group definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/EmailGroup"
}
},
"limit":{
"title":"limit",
"description":"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: ?limit=5.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-emailGroups-get",
"x-filename-id":"api-bulk-2.0-emailgroups-get"
}
},
"/api/rest/2.0/system/security/group":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the security group to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/SecurityGroupRest20"
}
}
],
"summary":"Create a security group",
"description":"Creates a new security group.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/SecurityGroupRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Security groups"
],
"x-internal-id":"api-rest-2.0-system-security-group-post",
"x-filename-id":"api-rest-2.0-system-security-group-post"
}
},
"/api/rest/2.0/system/security/group/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"The security group Id to retrieve",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. The default value is minimal.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a security group",
"description":"Retrieves the security group specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/SecurityGroupRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Security groups"
],
"x-internal-id":"api-rest-2.0-system-security-group-{id}-get",
"x-filename-id":"api-rest-2.0-system-security-group-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the security group to be updated",
"required":true,
"schema":{
"$ref":"#/definitions/SecurityGroupRest20"
}
},
{
"name":"id",
"in":"path",
"description":"The Id of the security group to update",
"required":true,
"type":"integer"
}
],
"summary":"Update a security group",
"description":"Updates the security group specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/SecurityGroupRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Security groups"
],
"x-internal-id":"api-rest-2.0-system-security-group-{id}-put",
"x-filename-id":"api-rest-2.0-system-security-group-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"The Id of the security group to delete",
"required":true,
"type":"integer"
}
],
"summary":"Delete a security group",
"description":"Deletes the security group specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Security groups"
],
"x-internal-id":"api-rest-2.0-system-security-group-{id}-delete",
"x-filename-id":"api-rest-2.0-system-security-group-id-delete"
}
},
"/api/rest/2.0/system/security/groups":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. The default value is minimal.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the security group was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve security groups",
"description":"Retrieves a list of security groups in Eloqua.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultSecurityGroupRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Security groups"
],
"x-internal-id":"api-rest-2.0-system-security-groups-get",
"x-filename-id":"api-rest-2.0-system-security-groups-get"
}
},
"/api/rest/2.0/system/security/group/{id}/users":{
"get":{
"operationId":"GetUsersGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"The security group id, from which you want to retrieve users",
"required":true,
"type":"integer"
}
],
"summary":"Retrieve a list of users",
"description":"Retrieves a list of users that belong to the specified security group",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultSecurityGroupUserRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Security groups"
],
"x-internal-id":"api-rest-2.0-system-security-group-{id}-users-get",
"x-filename-id":"api-rest-2.0-system-security-group-id-users-get"
},
"patch":{
"operationId":"PatchUsersPATCHRest20",
"parameters":[
{
"name":"securityGroupUsers",
"in":"body",
"description":"Array of users to add or remove from the group",
"required":true,
"items":{
"$ref":"#/definitions/SecurityGroupUserRest20"
},
"schema":{
"type":"array"
}
},
{
"name":"id",
"in":"path",
"description":"The security group id, from which you want to add or remove users",
"required":true,
"type":"integer"
}
],
"summary":"Add or remove users from a security group",
"description":"Adds or removes users from a security group.",
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/SecurityGroupUserRest20"
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Security groups"
],
"x-internal-id":"api-rest-2.0-system-security-group-{id}-users-patch",
"x-filename-id":"api-rest-2.0-system-security-group-id-users-patch"
}
},
"/api/rest/2.0/assets/dedupeRules":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"sourceType",
"in":"query",
"description":"Source Entity Type E.g. 1 (for contact), endpoint uses it to filter out the result if provided",
"required":false,
"type":"integer"
},
{
"name":"targetType",
"in":"query",
"description":"Target Entity Type E.g. 2 (for Company), endpoint uses it to filter out the result if provided",
"required":false,
"type":"integer"
},
{
"name":"IsMatchRule",
"in":"query",
"description":"Field that specifies if this is a Dedupe Rule or Match Rule. Fetches Both if not specified",
"required":false,
"type":"boolean"
},
{
"name":"IsCompleted",
"in":"query",
"description":"Field that specifies if a Dedupe Rule or Match Rule is completed or not. Fetches Both if not specified",
"required":false,
"type":"boolean"
},
{
"name":"search",
"in":"query",
"description":"Search term",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Max records in a page to be fetched",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"Page number to be fetched",
"required":false,
"type":"integer"
}
],
"summary":"Search for Dedupe Rules and Match Rules by Name",
"description":"Search for Dedupe Rules and Match Rules by Name and select Either or both using parameters",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultDedupeRuleRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Dedupe Rules"
],
"x-internal-id":"api-rest-2.0-assets-dedupeRules-get",
"x-filename-id":"api-rest-2.0-assets-deduperules-get"
}
},
"/api/rest/2.0/assets/dedupeRule/{ruleId}/handlerSets":{
"get":{
"operationId":"GetHandlerSetsGETRest20",
"parameters":[
{
"name":"ruleId",
"in":"path",
"description":"ID of the Dedupe Rule or Match Rule",
"required":true,
"type":"integer"
},
{
"name":"isNonMatchesDestination",
"in":"query",
"description":"Field that specifies if a Dedupe Rule or Match Rule Handler Set contains any Non-Matches Destination Handlers or not. Fetches Both if not specified",
"required":false,
"type":"boolean"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. The default value is minimal.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
}
],
"summary":"Get the Dedupe Rule or Match Rule Handler Sets",
"description":"Get the Dedupe Rule or Match Rule Handler Sets by the indicated Rule ID",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultDedupeRuleHandlerSetRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Dedupe Rules"
],
"x-internal-id":"api-rest-2.0-assets-dedupeRule-{ruleId}-handlerSets-get",
"x-filename-id":"api-rest-2.0-assets-deduperule-ruleid-handlersets-get"
}
},
"/api/rest/2.0/assets/dedupeRule/{ruleId}/handlerSet/{id}":{
"get":{
"operationId":"GetHandlerSetGETRest20",
"parameters":[
{
"name":"ruleId",
"in":"path",
"description":"ID of the Dedupe Rule or Match Rule",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"ID of the Dedupe Rule or Match Rule Handler Set",
"required":true,
"type":"integer"
}
],
"summary":"Get single Dedupe Rule or Match Rule Handler Set",
"description":"Get the Dedupe Rule or Match Rule Handler Set by the indicated Rule ID and Rule Handler Set ID",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/DedupeRuleHandlerSetRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Dedupe Rules"
],
"x-internal-id":"api-rest-2.0-assets-dedupeRule-{ruleId}-handlerSet-{id}-get",
"x-filename-id":"api-rest-2.0-assets-deduperule-ruleid-handlerset-id-get"
}
},
"/api/rest/2.0/assets/dedupeRule/{ruleId}":{
"get":{
"operationId":"GetDedupeRuleByIdGETRest20",
"parameters":[
{
"name":"ruleId",
"in":"path",
"description":"ID of the Dedupe Rule or Match Rule",
"required":true,
"type":"integer"
}
],
"summary":"Get single Dedupe Rule or Match Rule ",
"description":"Get single Dedupe Rule or Match Rule by ID",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/DedupeRuleRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Dedupe Rules"
],
"x-internal-id":"api-rest-2.0-assets-dedupeRule-{ruleId}-get",
"x-filename-id":"api-rest-2.0-assets-deduperule-ruleid-get"
}
},
"/api/rest/2.0/assets/contact/segment/folder":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the folder to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest20"
}
}
],
"summary":"Create a folder",
"description":"Creates a folder that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact segment folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-segment-folder-post",
"x-filename-id":"api-rest-2.0-assets-contact-segment-folder-post"
}
},
"/api/rest/2.0/assets/contact/segment/folder/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"string"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"extensions",
"in":"query",
"description":"ISegmentFolderService_Parameter_ReadIndividual_extensions_Description",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a folder",
"description":"Retrieves the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact segment folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-segment-folder-{id}-get",
"x-filename-id":"api-rest-2.0-assets-contact-segment-folder-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the folder to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"string"
}
],
"summary":"Update a folder",
"description":"The request body defines the details of the folder to be updated.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact segment folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-segment-folder-{id}-put",
"x-filename-id":"api-rest-2.0-assets-contact-segment-folder-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"string"
}
],
"summary":"Delete a folder",
"description":"Deletes the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact segment folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-segment-folder-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-contact-segment-folder-id-delete"
}
},
"/api/rest/2.0/assets/contact/segment/folders":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"string"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"string"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"string"
},
{
"name":"extensions",
"in":"query",
"description":"ISegmentFolderService_Parameter_Search_extensions_Description",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a list of folders",
"description":"Retrieves all folders that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact segment folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-segment-folders-get",
"x-filename-id":"api-rest-2.0-assets-contact-segment-folders-get"
}
},
"/api/rest/2.0/assets/contact/segment/folder/root":{
"get":{
"operationId":"ReadRootFolderGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"extensions",
"in":"query",
"description":"ISegmentFolderService_Parameter_ReadRootFolder_extensions_Description",
"required":false,
"type":"string"
}
],
"summary":"Retrieve the root folder",
"description":"Retrieves the root folder.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact segment folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-segment-folder-root-get",
"x-filename-id":"api-rest-2.0-assets-contact-segment-folder-root-get"
}
},
"/api/rest/2.0/assets/contact/segment/folder/root/contents":{
"get":{
"operationId":"SearchRootContentsGETRest20",
"parameters":[
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"string"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"string"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"string"
},
{
"name":"extensions",
"in":"query",
"description":"ISegmentFolderService_Parameter_SearchRootContents_extensions_Description",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a list of folder contents in the root folder",
"description":"Retrieves all folder contents in the root folder that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContractObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact segment folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-segment-folder-root-contents-get",
"x-filename-id":"api-rest-2.0-assets-contact-segment-folder-root-contents-get"
}
},
"/api/rest/2.0/assets/contact/segment/folder/{id}/contents":{
"get":{
"operationId":"SearchContentsGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"string"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"string"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"string"
},
{
"name":"extensions",
"in":"query",
"description":"ISegmentFolderService_Parameter_SearchContents_extensions_Description",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a list of folder contents",
"description":"Retrieves all folder contents that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContractObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact segment folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-segment-folder-{id}-contents-get",
"x-filename-id":"api-rest-2.0-assets-contact-segment-folder-id-contents-get"
},
"patch":{
"operationId":"BatchMovePATCHRest20",
"parameters":[
{
"name":"contents",
"in":"body",
"description":"The contents to place in the folder.",
"required":true,
"items":{
"$ref":"#/definitions/MinimalRest20"
},
"schema":{
"type":"array"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"string"
}
],
"summary":"Add content to a folder",
"description":"Places all content into the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/MinimalRest20"
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Contact segment folders"
],
"x-internal-id":"api-rest-2.0-assets-contact-segment-folder-{id}-contents-patch",
"x-filename-id":"api-rest-2.0-assets-contact-segment-folder-id-contents-patch"
}
},
"/API/OData/OpportunityAnalysis/1/Account":{
"get":{
"tags":[
"Reporting/OpportunityAnalysis/1.0/Account"
],
"summary":"Get all Accounts",
"operationId":"Account_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Accounts successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Account"
}
}
}
},
"x-internal-id":"API-OData-OpportunityAnalysis-1-Account-get",
"x-filename-id":"api-odata-opportunityanalysis-1-account-get"
}
},
"/API/OData/OpportunityAnalysis/1/Account/{key}":{
"get":{
"tags":[
"Reporting/OpportunityAnalysis/1.0/Account"
],
"summary":"Get a single Account",
"operationId":"Account_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"Account ID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Account was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Account"
}
}
}
},
"x-internal-id":"API-OData-OpportunityAnalysis-1-Account-{key}-get",
"x-filename-id":"api-odata-opportunityanalysis-1-account-key-get"
}
},
"/API/OData/OpportunityAnalysis/1/AccountCampaignScore":{
"get":{
"tags":[
"Reporting/OpportunityAnalysis/1.0/AccountCampaignScore"
],
"summary":"Get all Account Campaign Scores\r\nThis endpoint is only available for Guided Campaign customers.",
"operationId":"AccountCampaignScore_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Success",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/AccountCampaignScore"
}
}
},
"400":{
"description":"The query specified in the URI is not valid. The Guided Campaign module is required to access this entity"
},
"401":{
"description":"Unauthorized"
},
"403":{
"description":"Eloqua Analyzer license is required."
}
},
"x-internal-id":"API-OData-OpportunityAnalysis-1-AccountCampaignScore-get",
"x-filename-id":"api-odata-opportunityanalysis-1-accountcampaignscore-get"
}
},
"/API/OData/OpportunityAnalysis/1/AccountCampaignScore/{key}":{
"get":{
"tags":[
"Reporting/OpportunityAnalysis/1.0/AccountCampaignScore"
],
"summary":"Get a single Account\r\nThis endpoint is only available for Guided Campaign customers.",
"operationId":"AccountCampaignScore_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"The requested Account identifier",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Success",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/AccountCampaignScore"
}
}
},
"400":{
"description":"The query specified in the URI is not valid. The Guided Campaign module is required to access this entity"
},
"401":{
"description":"Unauthorized"
},
"403":{
"description":"Eloqua Analyzer license is required."
}
},
"x-internal-id":"API-OData-OpportunityAnalysis-1-AccountCampaignScore-{key}-get",
"x-filename-id":"api-odata-opportunityanalysis-1-accountcampaignscore-key-get"
}
},
"/API/OData/OpportunityAnalysis/1/AccountEngagement":{
"get":{
"tags":[
"Reporting/OpportunityAnalysis/1.0/AccountEngagement"
],
"summary":"Get all Account Engagements",
"operationId":"AccountEngagement_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"AccountsEngagements successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/AccountEngagement"
}
}
}
},
"x-internal-id":"API-OData-OpportunityAnalysis-1-AccountEngagement-get",
"x-filename-id":"api-odata-opportunityanalysis-1-accountengagement-get"
}
},
"/API/OData/OpportunityAnalysis/1/AccountEngagement/{key}":{
"get":{
"tags":[
"Reporting/OpportunityAnalysis/1.0/AccountEngagement"
],
"summary":"Get a single AccountEngagement",
"operationId":"AccountEngagement_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"Account ID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"AccountEngagement was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/AccountEngagement"
}
}
}
},
"x-internal-id":"API-OData-OpportunityAnalysis-1-AccountEngagement-{key}-get",
"x-filename-id":"api-odata-opportunityanalysis-1-accountengagement-key-get"
}
},
"/API/OData/OpportunityAnalysis/1/Contact":{
"get":{
"tags":[
"Reporting/OpportunityAnalysis/1.0/Contact"
],
"summary":"Get all Contacts, Label access control is respected",
"operationId":"Contact_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Contacts successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Contact"
}
}
}
},
"x-internal-id":"API-OData-OpportunityAnalysis-1-Contact-get",
"x-filename-id":"api-odata-opportunityanalysis-1-contact-get"
}
},
"/API/OData/OpportunityAnalysis/1/Contact/{key}":{
"get":{
"tags":[
"Reporting/OpportunityAnalysis/1.0/Contact"
],
"summary":"Get a single contact, Label access control is respected",
"operationId":"Contact_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"ContactID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Contact was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Contact"
}
}
}
},
"x-internal-id":"API-OData-OpportunityAnalysis-1-Contact-{key}-get",
"x-filename-id":"api-odata-opportunityanalysis-1-contact-key-get"
}
},
"/API/OData/OpportunityAnalysis/1/Contact/{key}/Opportunities":{
"get":{
"tags":[
"Reporting/OpportunityAnalysis/1.0/Contact"
],
"summary":"Get all Opportunities for a specified Contact",
"operationId":"Contact_GetOpportunities",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"ContactID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Opportunity was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Opportunity"
}
}
}
},
"x-internal-id":"API-OData-OpportunityAnalysis-1-Contact-{key}-Opportunities-get",
"x-filename-id":"api-odata-opportunityanalysis-1-contact-key-opportunities-get"
}
},
"/API/OData/OpportunityAnalysis/1/Opportunity":{
"get":{
"tags":[
"Reporting/OpportunityAnalysis/1.0/Opportunity"
],
"summary":"Get all Opportunities",
"operationId":"Opportunity_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Opportunities successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Opportunity"
}
}
}
},
"x-internal-id":"API-OData-OpportunityAnalysis-1-Opportunity-get",
"x-filename-id":"api-odata-opportunityanalysis-1-opportunity-get"
}
},
"/API/OData/OpportunityAnalysis/1/Opportunity/{key}":{
"get":{
"tags":[
"Reporting/OpportunityAnalysis/1.0/Opportunity"
],
"summary":"Get a single Opportunity",
"operationId":"Opportunity_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"The requested Opportunity identifier",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Opportunity was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Opportunity"
}
}
}
},
"x-internal-id":"API-OData-OpportunityAnalysis-1-Opportunity-{key}-get",
"x-filename-id":"api-odata-opportunityanalysis-1-opportunity-key-get"
}
},
"/API/OData/OpportunityAnalysis/1/Opportunity/{key}/OpportunityRevenues":{
"get":{
"tags":[
"Reporting/OpportunityAnalysis/1.0/Opportunity"
],
"summary":"Get Opportunities Revenue for a specified Opportunity",
"operationId":"Opportunity_GetOpportunityRevenues",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"OpportunityID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/OpportunityRevenue"
}
}
}
},
"x-internal-id":"API-OData-OpportunityAnalysis-1-Opportunity-{key}-OpportunityRevenues-get",
"x-filename-id":"api-odata-opportunityanalysis-1-opportunity-key-opportunityrevenues-get"
}
},
"/API/OData/OpportunityAnalysis/1/OpportunityRevenue":{
"get":{
"tags":[
"Reporting/OpportunityAnalysis/1.0/OpportunityRevenue"
],
"summary":"Get all Opportunity Revenues",
"operationId":"OpportunityRevenue_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"OpportunityRevenue successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/OpportunityRevenue"
}
}
}
},
"x-internal-id":"API-OData-OpportunityAnalysis-1-OpportunityRevenue-get",
"x-filename-id":"api-odata-opportunityanalysis-1-opportunityrevenue-get"
}
},
"/api/rest/1.0/assets/contentSection":{
"post":{
"operationId":"CreateIndividualPOSTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the content section to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/ContentSectionRest10"
}
}
],
"summary":"Create a content section",
"description":"Creates a content section that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/ContentSectionRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Content sections"
],
"x-internal-id":"api-rest-1.0-assets-contentSection-post",
"x-filename-id":"api-rest-1.0-assets-contentsection-post"
}
},
"/api/rest/1.0/assets/contentSection/{id}":{
"get":{
"operationId":"ReadIndividualGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the content section.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a content section",
"description":"Retrieves a content section specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/ContentSectionRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Content sections"
],
"x-internal-id":"api-rest-1.0-assets-contentSection-{id}-get",
"x-filename-id":"api-rest-1.0-assets-contentsection-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the content section to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/ContentSectionRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the content section.",
"required":true,
"type":"integer"
}
],
"summary":"Update a content section",
"description":"Updates the content section specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/ContentSectionRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Content sections"
],
"x-internal-id":"api-rest-1.0-assets-contentSection-{id}-put",
"x-filename-id":"api-rest-1.0-assets-contentsection-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the content section.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a content section",
"description":"Deletes a content section specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Content sections"
],
"x-internal-id":"api-rest-1.0-assets-contentSection-{id}-delete",
"x-filename-id":"api-rest-1.0-assets-contentsection-id-delete"
}
},
"/api/rest/1.0/assets/contentSections":{
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"Unix timestamp for the date and time the content section was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of content sections",
"description":"Retrieves all content sections that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContentSectionRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Content sections"
],
"x-internal-id":"api-rest-1.0-assets-contentSections-get",
"x-filename-id":"api-rest-1.0-assets-contentsections-get"
}
},
"/api/rest/1.0/data/account":{
"post":{
"operationId":"CreateIndividualPOSTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the account to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/AccountRest10"
}
}
],
"summary":"Create an account",
"description":"Creates an account that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/AccountRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Accounts"
],
"x-internal-id":"api-rest-1.0-data-account-post",
"x-filename-id":"api-rest-1.0-data-account-post"
}
},
"/api/rest/1.0/data/account/{id}":{
"get":{
"operationId":"ReadIndividualGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the account.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
},
{
"name":"viewId",
"in":"query",
"description":"Id of the account view.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve an account",
"description":"Retrieves the account specified by the id parameter",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/AccountRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Accounts"
],
"x-internal-id":"api-rest-1.0-data-account-{id}-get",
"x-filename-id":"api-rest-1.0-data-account-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"List of account fields.",
"required":true,
"schema":{
"$ref":"#/definitions/AccountRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the account.",
"required":true,
"type":"integer"
}
],
"summary":"Update an account",
"description":"Updates the account specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/AccountRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Accounts"
],
"x-internal-id":"api-rest-1.0-data-account-{id}-put",
"x-filename-id":"api-rest-1.0-data-account-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the account.",
"required":true,
"type":"integer"
}
],
"summary":"Delete an account",
"description":"Deletes the account specified by the id parameter.",
"responses":{
"204":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"The account you are attempting to delete has dependencies, and cannot be deleted"
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Accounts"
],
"x-internal-id":"api-rest-1.0-data-account-{id}-delete",
"x-filename-id":"api-rest-1.0-data-account-id-delete"
}
},
"/api/rest/1.0/data/accounts":{
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the account was last updated. This is a read-only property.",
"required":false,
"type":"integer"
},
{
"name":"viewId",
"in":"query",
"description":"Id of the account view to filter results. Must be a valid account view id. Example: /api/REST/1.0/data/accounts?viewId=100005.",
"required":false,
"type":"integer"
},
{
"name":"ownedByUserId",
"in":"query",
"description":"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 linkUsers parameter in this tutorial.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of accounts",
"description":"Retrieves all accounts that match the criteria specified by the request parameters",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultAccountRest10"
}
},
"204":{
"description":"No matching accounts were found in the search"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Accounts"
],
"x-internal-id":"api-rest-1.0-data-accounts-get",
"x-filename-id":"api-rest-1.0-data-accounts-get"
}
},
"/api/rest/2.0/assets/form/folder":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the folder to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest20"
}
}
],
"summary":"Create a folder",
"description":"Creates a folder that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form folders"
],
"x-internal-id":"api-rest-2.0-assets-form-folder-post",
"x-filename-id":"api-rest-2.0-assets-form-folder-post"
}
},
"/api/rest/2.0/assets/form/folder/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a folder",
"description":"Retrieves the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form folders"
],
"x-internal-id":"api-rest-2.0-assets-form-folder-{id}-get",
"x-filename-id":"api-rest-2.0-assets-form-folder-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the folder to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
}
],
"summary":"Update a folder",
"description":"The request body defines the details of the folder to be updated.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form folders"
],
"x-internal-id":"api-rest-2.0-assets-form-folder-{id}-put",
"x-filename-id":"api-rest-2.0-assets-form-folder-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a folder",
"description":"Deletes the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form folders"
],
"x-internal-id":"api-rest-2.0-assets-form-folder-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-form-folder-id-delete"
}
},
"/api/rest/2.0/assets/form/folders":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
},
{
"name":"includeAvailable",
"in":"query",
"description":"Specifies whether to include unarchived forms in the results, considered true if not specified.",
"required":false,
"type":"boolean"
},
{
"name":"includeArchived",
"in":"query",
"description":"Specifies whether to include archived forms in the results, considered false if not specified.",
"required":false,
"type":"boolean"
}
],
"summary":"Retrieve a list of folders",
"description":"Retrieves all folders that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form folders"
],
"x-internal-id":"api-rest-2.0-assets-form-folders-get",
"x-filename-id":"api-rest-2.0-assets-form-folders-get"
}
},
"/api/rest/2.0/assets/form/folder/{id}/contents":{
"get":{
"operationId":"SearchContentsGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of folder contents",
"description":"Retrieves all folder contents that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContractObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form folders"
],
"x-internal-id":"api-rest-2.0-assets-form-folder-{id}-contents-get",
"x-filename-id":"api-rest-2.0-assets-form-folder-id-contents-get"
},
"patch":{
"operationId":"BatchMovePATCHRest20",
"parameters":[
{
"name":"contents",
"in":"body",
"description":"The contents to place in the folder.",
"required":true,
"items":{
"$ref":"#/definitions/MinimalRest20"
},
"schema":{
"type":"array"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
}
],
"summary":"Add content to a folder",
"description":"Places all content into the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/MinimalRest20"
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form folders"
],
"x-internal-id":"api-rest-2.0-assets-form-folder-{id}-contents-patch",
"x-filename-id":"api-rest-2.0-assets-form-folder-id-contents-patch"
}
},
"/api/rest/2.0/assets/form/folder/root/contents":{
"get":{
"operationId":"SearchRootContentsGETRest20",
"parameters":[
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
},
{
"name":"includeAvailable",
"in":"query",
"description":"Specifies whether to include unarchived forms in the results, considered true if not specified.",
"required":false,
"type":"boolean"
},
{
"name":"includeArchived",
"in":"query",
"description":"Specifies whether to include archived forms in the results, considered false if not specified.",
"required":false,
"type":"boolean"
}
],
"summary":"Retrieve a list of folder contents in the root folder",
"description":"Retrieves all folder contents in the root folder that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContractObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form folders"
],
"x-internal-id":"api-rest-2.0-assets-form-folder-root-contents-get",
"x-filename-id":"api-rest-2.0-assets-form-folder-root-contents-get"
}
},
"/api/rest/2.0/assets/form/folder/root":{
"get":{
"operationId":"ReadRootFolderGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve the root folder",
"description":"Retrieves the root folder.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form folders"
],
"x-internal-id":"api-rest-2.0-assets-form-folder-root-get",
"x-filename-id":"api-rest-2.0-assets-form-folder-root-get"
}
},
"/api/rest/2.0/assets/form/folder/root/folders":{
"get":{
"operationId":"SearchRootSubFoldersGETRest20",
"parameters":[
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
},
{
"name":"includeAvailable",
"in":"query",
"description":"Specifies whether to include unarchived forms in the results, considered true if not specified.",
"required":false,
"type":"boolean"
},
{
"name":"includeArchived",
"in":"query",
"description":"Specifies whether to include archived forms in the results, considered false if not specified.",
"required":false,
"type":"boolean"
}
],
"summary":"Retrieve a list of subfolders in the root folder",
"description":"Retrieves all subfolders in the root folder that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form folders"
],
"x-internal-id":"api-rest-2.0-assets-form-folder-root-folders-get",
"x-filename-id":"api-rest-2.0-assets-form-folder-root-folders-get"
}
},
"/api/rest/2.0/assets/form/folder/{id}/folders":{
"get":{
"operationId":"SearchSubFoldersGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of subfolders",
"description":"Retrieves all subfolders that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form folders"
],
"x-internal-id":"api-rest-2.0-assets-form-folder-{id}-folders-get",
"x-filename-id":"api-rest-2.0-assets-form-folder-id-folders-get"
}
},
"/api/bulk/2.0/emailAddresses/imports":{
"get":{
"tags":[
"Bulk/2.0/emailAddresses"
],
"summary":"Retrieve a list of email address import definitions",
"description":"Retrieves a list of email address import definitions.",
"operationId":"GetEmailAddressImportSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"EmailAddressImportSearchResponse",
"description":"The response body contains information about the email address import definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/Import"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-emailAddresses-imports-get",
"x-filename-id":"api-bulk-2.0-emailaddresses-imports-get"
},
"post":{
"tags":[
"Bulk/2.0/emailAddresses"
],
"summary":"Create an email address import definition",
"description":"Creates a new email address import definition. The Bulk API's emailAddresses import allows you to change the global subscription status of email addresses without having to create a contact. The global subscription status can only be changed to unsubscribed. When an email address is imported this way, any present or future contact in Eloqua with the same email address will be automatically globally unsubscribed. Alternatively, to globally subscribe an email address, the /contacts/imports and /contacts/exports endpoints can be used with a sync action.",
"operationId":"PostEmailAddressImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"EmailAddressImportIndividual",
"in":"body",
"description":"The request body contains details of the email address import definition.",
"required":true,
"schema":{
"title":"EmailAddressImportIndividual",
"description":"The request body defines the details of the email address import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"EmailAddressImportIndividualResponse",
"description":"The response body includes information about the email address import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-emailAddresses-imports-post",
"x-filename-id":"api-bulk-2.0-emailaddresses-imports-post"
}
},
"/api/bulk/2.0/emailAddresses/imports/{id}":{
"get":{
"tags":[
"Bulk/2.0/emailAddresses"
],
"summary":"Retrieve an email address import definition",
"description":"Retrieves an email address import definition.",
"operationId":"GetEmailAddressImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The email address import definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"EmailAddressImportIndividualResponse",
"description":"The response body includes information about the email address import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-emailAddresses-imports-{id}-get",
"x-filename-id":"api-bulk-2.0-emailaddresses-imports-id-get"
},
"put":{
"tags":[
"Bulk/2.0/emailAddresses"
],
"summary":"Update an email address import definition",
"description":"Updates an email address import definition. For PUT requests, the parameters below are required for validation, even if they are not changing.",
"operationId":"PutEmailAddressImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The email address import definition's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"EmailAddressImportIndividual",
"in":"body",
"description":"The request body contains details of the email address import definition.",
"required":true,
"schema":{
"title":"EmailAddressImportIndividual",
"description":"The request body defines the details of the email address import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"EmailAddressImportIndividualResponse",
"description":"The response body includes information about the email address import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-emailAddresses-imports-{id}-put",
"x-filename-id":"api-bulk-2.0-emailaddresses-imports-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/emailAddresses"
],
"summary":"Delete an email address import definition",
"description":"Deletes an email address import definition.",
"operationId":"DeleteEmailAddressImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The email address import definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-emailAddresses-imports-{id}-delete",
"x-filename-id":"api-bulk-2.0-emailaddresses-imports-id-delete"
}
},
"/api/bulk/2.0/emailAddresses/imports/{id}/data":{
"post":{
"tags":[
"Bulk/2.0/emailAddresses"
],
"summary":"Submit data for an email address import",
"description":"Submits the data for the email address import with the specified id. The Bulk API's emailAddresses import allows you to change the global subscription status of email addresses to unsubscribed without having to create a contact. When an email address is imported this way, any present or future contact in Eloqua with the same email address will be automatically globally unsubscribed.",
"operationId":"PostEmailAddressImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The email address import definition's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"EmailAddressImportData",
"in":"body",
"description":"The request body contains the list of email addresses to be unsubscribed.",
"required":true,
"schema":{
"title":"EmailAddressImportData",
"type":"array",
"items":{
"title":"EmailAddressImportDataItem",
"type":"object",
"items":{
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"EmailAddressImportDataResponse",
"description":"Sync response when POSTing emailAddresses import data, and isSyncTriggeredOnImport = true on the import definition.",
"properties":{
"callbackUrl":{
"title":"callbackUrl",
"description":"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.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"status":{
"$ref":"#/definitions/SyncStatusType"
},
"syncedInstanceUri":{
"title":"syncedInstanceUri",
"description":"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.",
"type":"string"
},
"syncEndedAt":{
"format":"date-time",
"title":"syncEndedAt",
"description":"The date and time the sync ended. This is a read-only property.",
"type":"string"
},
"syncStartedAt":{
"format":"date-time",
"title":"syncStartedAt",
"description":"The date and time the sync started. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-emailAddresses-imports-{id}-data-post",
"x-filename-id":"api-bulk-2.0-emailaddresses-imports-id-data-post"
},
"delete":{
"tags":[
"Bulk/2.0/emailAddresses"
],
"summary":"Delete an email address import definition's synced data",
"description":"Deletes an email address import definition's synced data.",
"operationId":"DeleteEmailAddressImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The email address import definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-emailAddresses-imports-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-emailaddresses-imports-id-data-delete"
}
},
"/api/rest/2.0/assets/campaign":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the campaign to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/CampaignRest20"
}
},
{
"name":"externalSystemId",
"in":"query",
"description":"ICampaignService_Parameter_CreateIndividual_externalSystemId_Description",
"required":false,
"type":"integer"
}
],
"summary":"Create a campaign",
"description":"Creates a campaign that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/CampaignRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaigns"
],
"x-internal-id":"api-rest-2.0-assets-campaign-post",
"x-filename-id":"api-rest-2.0-assets-campaign-post"
}
},
"/api/rest/2.0/assets/campaign/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the campaign.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
},
{
"name":"externalSystemId",
"in":"query",
"description":"ICampaignService_Parameter_ReadIndividual_externalSystemId_Description",
"required":false,
"type":"integer"
},
{
"name":"includeCrmIdsMapping",
"in":"query",
"description":"ICampaignService_Parameter_ReadIndividual_includeCrmIdsMapping_Description",
"required":false,
"type":"boolean"
}
],
"summary":"Retrieve a campaign",
"description":"Retrieves a single campaign specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/CampaignRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaigns"
],
"x-internal-id":"api-rest-2.0-assets-campaign-{id}-get",
"x-filename-id":"api-rest-2.0-assets-campaign-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the campaign to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/CampaignRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the campaign.",
"required":true,
"type":"string"
},
{
"name":"externalSystemId",
"in":"query",
"description":"ICampaignService_Parameter_UpdateIndividual_externalSystemId_Description",
"required":false,
"type":"integer"
}
],
"summary":"Update a campaign",
"description":"Updates a campaign specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/CampaignRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaigns"
],
"x-internal-id":"api-rest-2.0-assets-campaign-{id}-put",
"x-filename-id":"api-rest-2.0-assets-campaign-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the campaign.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a campaign",
"description":"Deletes a campaign specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaigns"
],
"x-internal-id":"api-rest-2.0-assets-campaign-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-campaign-id-delete"
}
},
"/api/rest/2.0/assets/campaign/active/{id}":{
"post":{
"operationId":"ActivateIndividualPOSTRest20",
"parameters":[
{
"name":"scheduledFor",
"in":"query",
"description":"The date and time for the campaign to activate on expressed in Unix time. Alternatively, you can activate the campaign immediately by specifying 'now'.",
"required":false,
"type":"string"
},
{
"name":"id",
"in":"path",
"description":"Id of the campaign.",
"required":true,
"type":"integer"
},
{
"name":"runAsUserId",
"in":"query",
"description":"The username to activate the campaign.",
"required":false,
"type":"integer"
},
{
"name":"activateNow",
"in":"query",
"description":"Whether or not to activate the campaign immediately.",
"required":false,
"type":"boolean"
}
],
"summary":"Activate a campaign",
"description":"Activates a campaign specified by the id parameter.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/CampaignRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaigns"
],
"x-internal-id":"api-rest-2.0-assets-campaign-active-{id}-post",
"x-filename-id":"api-rest-2.0-assets-campaign-active-id-post"
}
},
"/api/rest/2.0/assets/campaign/draft/{id}":{
"post":{
"operationId":"DeactivateIndividualPOSTRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the campaign.",
"required":true,
"type":"integer"
}
],
"summary":"Deactivate a campaign",
"description":"Deactivates a campaign specified by the id parameter.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/CampaignRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaigns"
],
"x-internal-id":"api-rest-2.0-assets-campaign-draft-{id}-post",
"x-filename-id":"api-rest-2.0-assets-campaign-draft-id-post"
}
},
"/api/rest/2.0/assets/campaigns":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. The default value is minimal.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the campaign was last updated.",
"required":false,
"type":"integer"
},
{
"name":"externalSystemId",
"in":"query",
"description":"ICampaignService_Parameter_Search_externalSystemId_Description",
"required":false,
"type":"integer"
},
{
"name":"includeCrmIdsMapping",
"in":"query",
"description":"ICampaignService_Parameter_Search_includeCrmIdsMapping_Description",
"required":false,
"type":"boolean"
}
],
"summary":"Retrieve a list of campaigns",
"description":"Retrieves all campaigns that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultCampaignRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Campaigns"
],
"x-internal-id":"api-rest-2.0-assets-campaigns-get",
"x-filename-id":"api-rest-2.0-assets-campaigns-get"
}
},
"/api/rest/2.0/data/form/{id}":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the form data to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/FormDataRest20"
}
},
{
"name":"id",
"in":"path",
"description":"The ID of the form",
"required":true,
"type":"integer"
}
],
"summary":"Create form data for a single form",
"description":"Creates form data for the form that matches the criteria specified by the request body. This endpoint will only create form data that is specified in the request body. If a form field contains a static value, the field must be included in the request body to update the static value.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/FormDataRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form data"
],
"x-internal-id":"api-rest-2.0-data-form-{id}-post",
"x-filename-id":"api-rest-2.0-data-form-id-post"
},
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"The ID of the form",
"required":true,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"startAt",
"in":"query",
"description":"The earliest date time for which the request will retrieve data, expressed in Unix time.",
"required":false,
"type":"integer"
},
{
"name":"endAt",
"in":"query",
"description":"The latest date time for which the request will retrieve data, expressed in Unix time.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve processed form data for a single form",
"description":"Retrieves the form data for the form specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultFormSubmissionRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form data"
],
"x-internal-id":"api-rest-2.0-data-form-{id}-get",
"x-filename-id":"api-rest-2.0-data-form-id-get"
}
},
"/api/rest/2.0/data/form/{id}/datarow/{rowId}":{
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"The ID of the form",
"required":true,
"type":"integer"
},
{
"name":"rowId",
"in":"path",
"description":"The ID of the form data",
"required":true,
"type":"integer"
}
],
"summary":"Delete form data",
"description":"Delete the form data of the form specified by the id parameter and row specified by the rowId parameter.",
"responses":{
"201":{
"description":"Success"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form data"
],
"x-internal-id":"api-rest-2.0-data-form-{id}-datarow-{rowId}-delete",
"x-filename-id":"api-rest-2.0-data-form-id-datarow-rowid-delete"
}
},
"/api/rest/2.0/data/form/{formId}/formData/{formSubmitJobId}":{
"get":{
"operationId":"GetAsyncFormSubmissionGETRest20",
"parameters":[
{
"name":"formId",
"in":"path",
"description":"The ID of the form",
"required":true,
"type":"string"
},
{
"name":"formSubmitJobId",
"in":"path",
"description":"The ID of the asynchronous form submission job",
"required":true,
"type":"string"
}
],
"summary":"Retrieve a single form submit job",
"description":"Retrieves asynchronous form submission data for a single form submit specified by the formId and formSubmitJobId parameters. This API endpoint is released under our Controlled Availability program. You can request access to this feature by submitting a request to My Oracle Support.",
"responses":{
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form data"
],
"x-internal-id":"api-rest-2.0-data-form-{formId}-formData-{formSubmitJobId}-get",
"x-filename-id":"api-rest-2.0-data-form-formid-formdata-formsubmitjobid-get"
}
},
"/api/rest/2.0/data/form/{formId}/formData":{
"get":{
"operationId":"SearchAsyncFormSubmissionGETRest20",
"parameters":[
{
"name":"formId",
"in":"path",
"description":"The ID of the form",
"required":true,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"string"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"string"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"startAt",
"in":"query",
"description":"The earliest date time for which the request will retrieve data, expressed in Unix time.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve all form submit jobs for a single form",
"description":"Retrieves all asynchronous form submissions for a form specified by the formId.",
"responses":{
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form data"
],
"x-internal-id":"api-rest-2.0-data-form-{formId}-formData-get",
"x-filename-id":"api-rest-2.0-data-form-formid-formdata-get"
}
},
"/api/rest/2.0/data/form/{formId}/formSpamData":{
"get":{
"operationId":"SearchFormSpamSubmissionGETRest20",
"parameters":[
{
"name":"formId",
"in":"path",
"description":"ID of the form.",
"required":true,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"startAt",
"in":"query",
"description":"The earliest date time for which the request will retrieve data, expressed in Unix time.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve all spam form submit jobs for a single form",
"description":"Retrieves all spam form submissions for a form specified by the formId. This API endpoint is released under our Controlled Availability program. You can request access to this feature by submitting a request to My Oracle Support.",
"responses":{
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form data"
],
"x-internal-id":"api-rest-2.0-data-form-{formId}-formSpamData-get",
"x-filename-id":"api-rest-2.0-data-form-formid-formspamdata-get"
}
},
"/api/rest/2.0/data/form/{id}/batch":{
"post":{
"operationId":"CreateBatchRequestPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the form data in a batch to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/AsyncFormSubmissionBatchRest20"
}
},
{
"name":"id",
"in":"path",
"description":"The ID of the form",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Create form data in batch for a single form",
"description":"Creates form data in batch for the form that matches the criteria specified by the request body. This endpoint will only create all form data specified in the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/AsyncFormSubmissionBatchRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form data"
],
"x-internal-id":"api-rest-2.0-data-form-{id}-batch-post",
"x-filename-id":"api-rest-2.0-data-form-id-batch-post"
}
},
"/api/rest/2.0/data/form/{formId}/batch/formData/{batchId}":{
"get":{
"operationId":"GetAsyncFormSubmissionBatchByBatchIdGETRest20",
"parameters":[
{
"name":"formId",
"in":"path",
"description":"The ID of the form",
"required":true,
"type":"integer"
},
{
"name":"batchId",
"in":"path",
"description":"The ID of the batch",
"required":true,
"type":"string"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve batch form submission details by batchId",
"description":"Retrieves batch form submission details for the specified formId and batchId",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/AsyncFormSubmissionBatchRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form data"
],
"x-internal-id":"api-rest-2.0-data-form-{formId}-batch-formData-{batchId}-get",
"x-filename-id":"api-rest-2.0-data-form-formid-batch-formdata-batchid-get"
}
},
"/api/rest/2.0/data/form/{formId}/batchCorrelation/formData/{batchCorrelationId}":{
"get":{
"operationId":"GetAsyncFormSubmissionBatchByBatchCorrelationIdGETRest20",
"parameters":[
{
"name":"formId",
"in":"path",
"description":"The ID of the form",
"required":true,
"type":"integer"
},
{
"name":"batchCorrelationId",
"in":"path",
"description":"The Correlation ID of the batch",
"required":true,
"type":"string"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve batch form submission details by batchCorrelationId",
"description":"Retrieves batch form submission details for the specified formId and batchCorrelationId",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/AsyncFormSubmissionBatchRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Form data"
],
"x-internal-id":"api-rest-2.0-data-form-{formId}-batchCorrelation-formData-{batchCorrelationId}-get",
"x-filename-id":"api-rest-2.0-data-form-formid-batchcorrelation-formdata-batchcorrelationid-get"
}
},
"/api/rest/1.0/assets/email/group":{
"post":{
"operationId":"CreateIndividualPOSTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the email group to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/EmailGroupRest10"
}
}
],
"summary":"Create an email group",
"description":"Creates an email group that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/EmailGroupRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email groups"
],
"x-internal-id":"api-rest-1.0-assets-email-group-post",
"x-filename-id":"api-rest-1.0-assets-email-group-post"
}
},
"/api/rest/1.0/assets/email/group/{id}":{
"get":{
"operationId":"ReadIndividualGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the email group.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve an email group",
"description":"Retrieves the email group specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/EmailGroupRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email groups"
],
"x-internal-id":"api-rest-1.0-assets-email-group-{id}-get",
"x-filename-id":"api-rest-1.0-assets-email-group-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the email group to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/EmailGroupRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the email group to update.",
"required":true,
"type":"integer"
}
],
"summary":"Update an email group",
"description":"Updates the email group specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/EmailGroupRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email groups"
],
"x-internal-id":"api-rest-1.0-assets-email-group-{id}-put",
"x-filename-id":"api-rest-1.0-assets-email-group-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the email group to delete.",
"required":true,
"type":"integer"
}
],
"summary":"Delete an email group",
"description":"Deletes the email group specified by the id parameter.",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email groups"
],
"x-internal-id":"api-rest-1.0-assets-email-group-{id}-delete",
"x-filename-id":"api-rest-1.0-assets-email-group-id-delete"
}
},
"/api/rest/1.0/assets/email/groups":{
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email group was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of email groups",
"description":"Retrieves all email group that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultGroupRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email groups"
],
"x-internal-id":"api-rest-1.0-assets-email-groups-get",
"x-filename-id":"api-rest-1.0-assets-email-groups-get"
}
},
"/api/bulk/2.0/customObjects/{parentId}":{
"get":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Retrieve a custom object",
"description":"Retrieves a custom object that matches the criteria specified in the URL parameters.",
"operationId":"GetCustomObjectIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CustomObjectIndividualResponse",
"description":"The response body contains information about the custom object definition.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"displayNameFieldUri":{
"title":"displayNameFieldUri",
"description":"The relative uri used to reference the custom object field that represents the display field, for this custom object.",
"type":"string"
},
"emailAddressFieldUri":{
"title":"emailAddressFieldUri",
"description":"The relative uri used to reference the custom object field that represents an email address, for this custom object.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the custom object definition.",
"type":"string"
},
"uniqueFieldUri":{
"title":"uniqueFieldUri",
"description":"The relative uri used to reference the custom object field that has a uniqueness constraint on it, for this custom object.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-get",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-get"
}
},
"/api/bulk/2.0/customObjects/{parentId}/exports":{
"get":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Retrieve a list of export definitions for a custom object",
"description":"Retrieves the list of export definitions for the custom object with the specified id",
"operationId":"GetCustomObjectExportSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CustomObjectExportSearchResponse",
"description":"The response body contains information about the custom object export definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/Export"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-exports-get",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-exports-get"
},
"post":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Create an export definition for a custom object",
"description":"Creates a new export definition for the specified custom object. See the tutorial for details on how to export data.",
"operationId":"PostCustomObjectExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"CustomObjectExportIndividual",
"in":"body",
"description":"The request body contains details of the custom object export definition.",
"required":true,
"schema":{
"title":"CustomObjectExportIndividual",
"description":"The request body defines the details of the custom object export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"CustomObjectExportIndividualResponse",
"description":"The response body includes information about the custom object export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-exports-post",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-exports-post"
}
},
"/api/bulk/2.0/customObjects/{parentId}/fields":{
"get":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Retrieve a list of the fields for a custom object",
"description":"Retrieves a custom object field definition for the custom object and field ids provided.",
"operationId":"GetCustomObjectFieldSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CustomObjectFieldSearchResponse",
"description":"The response body contains information about the custom object field definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/CustomObjectField"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"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.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-fields-get",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-fields-get"
}
},
"/api/bulk/2.0/customObjects/{parentId}/imports":{
"get":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Retrieve a list of import definitions for a custom object",
"description":"Retrieves the list of import definitions for the custom object with the specified id.",
"operationId":"GetCustomObjectImportSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CustomObjectImportSearchResponse",
"description":"The response body contains information about the custom object import definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/Import"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-imports-get",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-imports-get"
},
"post":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Create an import definition for a custom object",
"description":"Creates a new import definition for the specified custom object. See the tutorial for details on how to import data.",
"operationId":"PostCustomObjectImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"CustomObjectImportIndividual",
"in":"body",
"description":"The request body contains details of the custom object import definition.",
"required":true,
"schema":{
"title":"CustomObjectImportIndividual",
"description":"The request body defines the details of the custom object import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"id":{
"title":"id",
"description":"The import definition???s resource identification number.",
"type":"integer"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"mapDataCards":{
"title":"mapDataCards",
"description":"Whether or not data cards will be mapped on import. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsCaseSensitiveMatch":{
"title":"mapDataCardsCaseSensitiveMatch",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsEntityField":{
"title":"mapDataCardsEntityField",
"description":"This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsEntityType":{
"title":"mapDataCardsEntityType",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsSourceField":{
"title":"mapDataCardsSourceField",
"description":"This field specifies the source document field that will be used for matching. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"parentId":{
"title":"parentId",
"description":"The parent object's resource identification number.",
"type":"integer"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"CustomObjectImportIndividualResponse",
"description":"The response body includes information about the custom object import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"mapDataCards":{
"title":"mapDataCards",
"description":"Whether or not data cards will be mapped on import. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsCaseSensitiveMatch":{
"title":"mapDataCardsCaseSensitiveMatch",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsEntityField":{
"title":"mapDataCardsEntityField",
"description":"This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsEntityType":{
"title":"mapDataCardsEntityType",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsSourceField":{
"title":"mapDataCardsSourceField",
"description":"This field specifies the source document field that will be used for matching. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-imports-post",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-imports-post"
}
},
"/api/bulk/2.0/customObjects/{parentId}/syncActions":{
"get":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Retrieve a list of sync action definitions for a custom object",
"description":"Retrieves a list of sync action definitions for the specified custom object.",
"operationId":"GetCustomObjectSyncActionOperationSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CustomObjectSyncActionOperationSearchResponse",
"description":"The response body contains information about the custom object sync action definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncActionOperation"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-syncActions-get",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-syncactions-get"
},
"post":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Create a custom object sync action definition",
"description":"Creates a new custom object sync action definition.",
"operationId":"PostCustomObjectSyncActionOperationIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"CustomObjectSyncActionOperationIndividual",
"in":"body",
"description":"The request body contains details of the custom object sync action definition.",
"required":true,
"schema":{
"title":"CustomObjectSyncActionOperationIndividual",
"description":"The request body defines details of the custom object sync action definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the sync action. This is a read-only property.",
"type":"string"
},
"fields":{
"title":"fields",
"description":"The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field.\r\n\r\nAllowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}.\r\n\r\nAllowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}.\r\n\r\nAllowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered upon uploading data.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kb. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the sync action definition.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. \r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"CustomObjectSyncActionOperationIndividualResponse",
"description":"The response body includes information about the custom object sync action definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the sync action. This is a read-only property.",
"type":"string"
},
"fields":{
"title":"fields",
"description":"The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field.\r\n\r\nAllowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}.\r\n\r\nAllowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}.\r\n\r\nAllowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered upon uploading data.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kb. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the sync action definition.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. \r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-syncActions-post",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-syncactions-post"
}
},
"/api/bulk/2.0/customObjects/{parentId}/exports/{id}":{
"get":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Retrieve the specified export definition for a custom object",
"description":"Retrieves the specified export definition for the specified custom object.",
"operationId":"GetCustomObjectExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The custom object export's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CustomObjectExportIndividualResponse",
"description":"The response body includes information about the custom object export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-exports-{id}-get",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-exports-id-get"
},
"put":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Update an export definition for a custom object",
"description":"Updates the specified export definition for the specified custom object.",
"operationId":"PutCustomObjectExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The custom object export's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"CustomObjectExportIndividual",
"in":"body",
"description":"The request body contains details of the custom object export definition.",
"required":true,
"schema":{
"title":"CustomObjectExportIndividual",
"description":"The request body defines the details of the custom object export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CustomObjectExportIndividualResponse",
"description":"The response body includes information about the custom object export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-exports-{id}-put",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-exports-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Delete a custom object export definition",
"description":"Deletes the specified custom object export definition.",
"operationId":"DeleteCustomObjectExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The custom object export's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-exports-{id}-delete",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-exports-id-delete"
}
},
"/api/bulk/2.0/customObjects/{parentId}/exports/{id}/data":{
"get":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Retrieve the synced data for a custom object export definition",
"description":"Retrieves the synced data for a custom object export definition.",
"operationId":"GetCustomObjectExportDataQuery",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The custom object export's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CustomObjectExportDataQueryResponse",
"description":"The response body includes information about the synced data for the custom object export definition.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"A list of the custom object's export data.",
"type":"array",
"items":{
"type":"object"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-exports-{id}-data-get",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-exports-id-data-get"
},
"delete":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Delete the synced data for a custom object export definition",
"description":"Deletes the synced data for the specified custom object export definition.",
"operationId":"DeleteCustomObjectExportDataQuery",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The custom object export's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-exports-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-exports-id-data-delete"
}
},
"/api/bulk/2.0/customObjects/{parentId}/fields/{id}":{
"get":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Retrieve a custom object field definition",
"description":"Retrieves a custom object field definition for the custom object and field ids provided.",
"operationId":"GetCustomObjectFieldIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CustomObjectFieldIndividualResponse",
"description":"The response body contains information about the custom object field definition.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataType":{
"$ref":"#/definitions/DataType"
},
"defaultValue":{
"title":"defaultValue",
"description":"The field's default value.",
"type":"string"
},
"hasNotNullConstraint":{
"title":"hasNotNullConstraint",
"description":"Indicates whether the field can have null values (i.e. empty).",
"type":"boolean"
},
"hasReadOnlyConstraint":{
"title":"hasReadOnlyConstraint",
"description":"Indicates whether the field can be written to.",
"type":"boolean"
},
"hasUniquenessConstraint":{
"title":"hasUniquenessConstraint",
"description":"Indicates whether the field must have a unique value.",
"type":"boolean"
},
"internalName":{
"title":"internalName",
"description":"The field's internal name (used to uniquely identify it).",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the custom object definition.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-fields-{id}-get",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-fields-id-get"
}
},
"/api/bulk/2.0/customObjects/{parentId}/imports/{id}":{
"get":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Retrieve an import definition for a custom object",
"description":"Retrieves the specified import definition for the specified custom object.",
"operationId":"GetCustomObjectImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The import definition???s resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CustomObjectImportIndividualResponse",
"description":"The response body includes information about the custom object import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"mapDataCards":{
"title":"mapDataCards",
"description":"Whether or not data cards will be mapped on import. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsCaseSensitiveMatch":{
"title":"mapDataCardsCaseSensitiveMatch",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsEntityField":{
"title":"mapDataCardsEntityField",
"description":"This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsEntityType":{
"title":"mapDataCardsEntityType",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsSourceField":{
"title":"mapDataCardsSourceField",
"description":"This field specifies the source document field that will be used for matching. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-imports-{id}-get",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-imports-id-get"
},
"put":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Update an import definition for a custom object",
"description":"Updates the specified import definition for the specified custom object.",
"operationId":"PutCustomObjectImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The import definition???s resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"CustomObjectImportIndividual",
"in":"body",
"description":"The request body contains details of the custom object import definition.",
"required":true,
"schema":{
"title":"CustomObjectImportIndividual",
"description":"The request body defines the details of the custom object import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"id":{
"title":"id",
"description":"The import definition???s resource identification number.",
"type":"integer"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"mapDataCards":{
"title":"mapDataCards",
"description":"Whether or not data cards will be mapped on import. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsCaseSensitiveMatch":{
"title":"mapDataCardsCaseSensitiveMatch",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsEntityField":{
"title":"mapDataCardsEntityField",
"description":"This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsEntityType":{
"title":"mapDataCardsEntityType",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsSourceField":{
"title":"mapDataCardsSourceField",
"description":"This field specifies the source document field that will be used for matching. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"parentId":{
"title":"parentId",
"description":"The parent object's resource identification number.",
"type":"integer"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CustomObjectImportIndividualResponse",
"description":"The response body includes information about the custom object import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"mapDataCards":{
"title":"mapDataCards",
"description":"Whether or not data cards will be mapped on import. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsCaseSensitiveMatch":{
"title":"mapDataCardsCaseSensitiveMatch",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"boolean"
},
"mapDataCardsEntityField":{
"title":"mapDataCardsEntityField",
"description":"This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsEntityType":{
"title":"mapDataCardsEntityType",
"description":"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 Oracle Eloqua Developer Help Center.",
"type":"string"
},
"mapDataCardsSourceField":{
"title":"mapDataCardsSourceField",
"description":"This field specifies the source document field that will be used for matching. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-imports-{id}-put",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-imports-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Delete a custom object import definition",
"description":"Deletes the specified custom object import definition.",
"operationId":"DeleteCustomObjectImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The import definition???s resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-imports-{id}-delete",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-imports-id-delete"
}
},
"/api/bulk/2.0/customObjects/{parentId}/imports/{id}/data":{
"post":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Upload data for a custom object import definition",
"description":"Uploads data for the specified custom object import definition. When uploading data, Eloqua expects that data to be encoded with UTF-8.",
"operationId":"PostCustomObjectImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The import definition???s resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"CustomObjectImportData",
"in":"body",
"description":"The request body contains data to be uploaded to the custom object import definition.",
"required":true,
"schema":{
"title":"CustomObjectImportData",
"type":"array",
"items":{
"title":"CustomObjectImportDataItem",
"type":"object",
"items":{
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"CustomObjectImportDataResponse",
"description":"Sync response when POSTing custom object import data, and isSyncTriggeredOnImport = true on the import definition.",
"properties":{
"callbackUrl":{
"title":"callbackUrl",
"description":"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.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"status":{
"$ref":"#/definitions/SyncStatusType"
},
"syncedInstanceUri":{
"title":"syncedInstanceUri",
"description":"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.",
"type":"string"
},
"syncEndedAt":{
"format":"date-time",
"title":"syncEndedAt",
"description":"The date and time the sync ended. This is a read-only property.",
"type":"string"
},
"syncStartedAt":{
"format":"date-time",
"title":"syncStartedAt",
"description":"The date and time the sync started. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"204":{
"description":"No content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-imports-{id}-data-post",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-imports-id-data-post"
},
"delete":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Delete synced data for a custom object import definition",
"description":"Deletes the synced data for the specified custom object import definition.",
"operationId":"DeleteCustomObjectImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The import definition???s resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-imports-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-imports-id-data-delete"
}
},
"/api/bulk/2.0/customObjects/{parentId}/syncActions/{id}":{
"get":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Retrieve a custom object sync action definition for a custom object",
"description":"Retrieve a custom object sync action definition for the specified custom object and sync action definition.",
"operationId":"GetCustomObjectSyncActionOperationIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The sync action definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CustomObjectSyncActionOperationIndividualResponse",
"description":"The response body includes information about the custom object sync action definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the sync action. This is a read-only property.",
"type":"string"
},
"fields":{
"title":"fields",
"description":"The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field.\r\n\r\nAllowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}.\r\n\r\nAllowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}.\r\n\r\nAllowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered upon uploading data.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kb. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the sync action definition.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. \r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-syncActions-{id}-get",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-syncactions-id-get"
},
"put":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Update a custom object sync action definition",
"description":"Updates the specified custom object sync action definition. For PUT requests, the parameters below are required for validation, even if they are not changing.",
"operationId":"PutCustomObjectSyncActionOperationIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The sync action definition's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"CustomObjectSyncActionOperationIndividual",
"in":"body",
"description":"The request body contains details of the custom object sync action definition.",
"required":true,
"schema":{
"title":"CustomObjectSyncActionOperationIndividual",
"description":"The request body defines details of the custom object sync action definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the sync action. This is a read-only property.",
"type":"string"
},
"fields":{
"title":"fields",
"description":"The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field.\r\n\r\nAllowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}.\r\n\r\nAllowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}.\r\n\r\nAllowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered upon uploading data.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kb. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the sync action definition.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. \r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CustomObjectSyncActionOperationIndividualResponse",
"description":"The response body includes information about the custom object sync action definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the sync action. This is a read-only property.",
"type":"string"
},
"fields":{
"title":"fields",
"description":"The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field.\r\n\r\nAllowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}.\r\n\r\nAllowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}.\r\n\r\nAllowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered upon uploading data.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kb. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the sync action definition.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. \r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-syncActions-{id}-put",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-syncactions-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Delete a custom object sync action definition",
"description":"Deletes the specified custom object sync action definition.",
"operationId":"DeleteCustomObjectSyncActionOperationIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The sync action definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-syncActions-{id}-delete",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-syncactions-id-delete"
}
},
"/api/bulk/2.0/customObjects/{parentId}/syncActions/{id}/data":{
"post":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Upload custom object sync action data",
"description":"Uploads custom object sync data for a specified custom object and sync action definition.",
"operationId":"PostCustomObjectSyncActionOperationData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The sync action definition's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"CustomObjectSyncActionOperationData",
"in":"body",
"description":"The request body contains details of the custom object sync action definition.",
"required":true,
"schema":{
"title":"CustomObjectSyncActionOperationData",
"type":"array",
"items":{
"title":"CustomObjectSyncActionOperationDataItem",
"type":"object",
"items":{
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"CustomObjectSyncActionOperationDataResponse",
"description":"Sync response when POSTing custom object sync action data, and isSyncTriggeredOnImport = true on the sync action definition.",
"properties":{
"callbackUrl":{
"title":"callbackUrl",
"description":"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.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"status":{
"$ref":"#/definitions/SyncStatusType"
},
"syncedInstanceUri":{
"title":"syncedInstanceUri",
"description":"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.",
"type":"string"
},
"syncEndedAt":{
"format":"date-time",
"title":"syncEndedAt",
"description":"The date and time the sync ended. This is a read-only property.",
"type":"string"
},
"syncStartedAt":{
"format":"date-time",
"title":"syncStartedAt",
"description":"The date and time the sync started. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"204":{
"description":"No content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-syncActions-{id}-data-post",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-syncactions-id-data-post"
},
"delete":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Delete sync data for a custom object sync action definition",
"description":"Deletes sync data for a specified custom object sync action.",
"operationId":"DeleteCustomObjectSyncActionOperationData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"parentId",
"in":"path",
"description":"The custom object's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"id",
"in":"path",
"description":"The sync action definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-{parentId}-syncActions-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-customobjects-parentid-syncactions-id-data-delete"
}
},
"/api/bulk/2.0/customObjects":{
"get":{
"tags":[
"Bulk/2.0/customObjects"
],
"summary":"Retrieve a list of custom objects",
"description":"Retrieves all custom objects that match the criteria specified in the URL parameters.",
"operationId":"GetCustomObjectSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"CustomObjectSearchResponse",
"description":"The response body contains information about the custom object definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/CustomObject"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-customObjects-get",
"x-filename-id":"api-bulk-2.0-customobjects-get"
}
},
"/api/rest/2.0/data/account/{id}/membership":{
"get":{
"operationId":"ListGroupMembershipGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the account to retrieve.",
"required":true,
"type":"integer"
}
],
"summary":"Retrieve account group membership information for an account",
"description":"Retrieves a list of account groups that an account is a member of.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/AccountGroupRest20"
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Accounts"
],
"x-internal-id":"api-rest-2.0-data-account-{id}-membership-get",
"x-filename-id":"api-rest-2.0-data-account-id-membership-get"
}
},
"/api/rest/2.0/data/accounts":{
"post":{
"operationId":"SearchAccountsSEARCHRest20",
"parameters":[
{
"name":"search",
"in":"body",
"description":"The request body defines the details of the request.",
"required":true,
"schema":{
"$ref":"#/definitions/EntitySearchByIdsRest20"
}
},
{
"name":"X-HTTP-Method-Override",
"in":"header",
"description":"The request header X-HTTP-Method-Override must be set with value SEARCH.",
"required":true,
"type":"string",
"format":"string",
"default":"SEARCH"
}
],
"summary":"Retrieve account information",
"description":"Retrieves account information for up to 200 accounts, searched by account id. Use the depth parameter when making the request to specify the account information returned in the response. Note that for accounts, minimal and partial depths return the same information.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/AccountRest20"
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Accounts"
],
"x-internal-id":"api-rest-2.0-data-accounts-post",
"x-filename-id":"api-rest-2.0-data-accounts-post"
}
},
"/api/rest/1.0/assets/optionList/{id}":{
"get":{
"operationId":"ReadIndividualGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the option list.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve an option list",
"description":"Retrieves the option list specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/OptionListRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Option lists"
],
"x-internal-id":"api-rest-1.0-assets-optionList-{id}-get",
"x-filename-id":"api-rest-1.0-assets-optionlist-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the option list to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/OptionListRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the option list. This is a read-only property.",
"required":true,
"type":"integer"
}
],
"summary":"Update an option list",
"description":"Updates the option list specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/OptionListRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Option lists"
],
"x-internal-id":"api-rest-1.0-assets-optionList-{id}-put",
"x-filename-id":"api-rest-1.0-assets-optionlist-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the option list",
"required":true,
"type":"integer"
}
],
"summary":"Delete an option list",
"description":"Deletes the option list specified by the id parameter.",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Option lists"
],
"x-internal-id":"api-rest-1.0-assets-optionList-{id}-delete",
"x-filename-id":"api-rest-1.0-assets-optionlist-id-delete"
}
},
"/api/rest/1.0/assets/optionLists":{
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the option list was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of option lists",
"description":"Retrieves all option lists that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultOptionListRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Option lists"
],
"x-internal-id":"api-rest-1.0-assets-optionLists-get",
"x-filename-id":"api-rest-1.0-assets-optionlists-get"
}
},
"/api/rest/1.0/assets/optionList":{
"post":{
"operationId":"CreateIndividualPOSTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the option list to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/OptionListRest10"
}
}
],
"summary":"Create an option list",
"description":"Creates an option list that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/OptionListRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Option lists"
],
"x-internal-id":"api-rest-1.0-assets-optionList-post",
"x-filename-id":"api-rest-1.0-assets-optionlist-post"
}
},
"/api/bulk/2.0/imports/data":{
"get":{
"tags":[
"Bulk/2.0/imports"
],
"summary":"Discover the amount of database space your imports are using",
"description":"This endpoint is used to discover how much space current imports are taking up in your database.",
"operationId":"GetImportStorage",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ImportStorageResponse",
"description":"Response for the import storage usage, filtered by the fields or fieldsUri.",
"properties":{
"kbAllowed":{
"format":"int64",
"title":"kbAllowed",
"description":"This value is set to \"0\" on purpose, this means there is no limit.",
"type":"integer"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space currently taking up in your database.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-imports-data-get",
"x-filename-id":"api-bulk-2.0-imports-data-get"
}
},
"/api/bulk/2.0/imports/priorities/{id}":{
"get":{
"tags":[
"Bulk/2.0/imports"
],
"summary":"Retrieve an import priority",
"description":"Retrieves an import priority.",
"operationId":"GetImportPriorityIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The unique resource identifier.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ImportPriorityIndividualResponse",
"description":"The response body contains information about the import priority definition.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"name":{
"title":"name",
"description":"The asset's name.",
"type":"string"
},
"priority":{
"title":"priority",
"description":"The import's queue position. This is a read-only property.",
"type":"integer"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-imports-priorities-{id}-get",
"x-filename-id":"api-bulk-2.0-imports-priorities-id-get"
}
},
"/api/bulk/2.0/imports/priorities":{
"get":{
"tags":[
"Bulk/2.0/imports"
],
"summary":"Retrieve a list of import priorities",
"description":"Retrieves a list of import priorities. Data import priority specifies the order in which Eloqua evaluates sources of data, and determines whether to update data in Eloqua. Data import priority is set within Eloqua.",
"operationId":"GetImportPrioritySearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ImportPrioritySearchResponse",
"description":"The response body contains information about the import priority definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The data endpoint returns whatever what synchronized. This is based on the fields parameter set in the initial import/export definition.",
"type":"array",
"items":{
"$ref":"#/definitions/ImportPriority"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-imports-priorities-get",
"x-filename-id":"api-bulk-2.0-imports-priorities-get"
}
},
"/api/bulk/2.0/imports":{
"get":{
"tags":[
"Bulk/2.0/imports"
],
"summary":"Retrieve a list of imports",
"description":"Retrieves a list of imports.",
"operationId":"GetImportSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ImportSearchResponse",
"description":"The response body contains information about the import definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The data endpoint returns whatever what synchronized. This is based on the fields parameter set in the initial import/export definition.",
"type":"array",
"items":{
"$ref":"#/definitions/Import"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-imports-get",
"x-filename-id":"api-bulk-2.0-imports-get"
}
},
"/api/rest/1.0/assets/contact/segment":{
"post":{
"operationId":"CreateIndividualPOSTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the contact segment to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/ContactSegmentRest10"
}
}
],
"summary":"Create a contact segment",
"description":"Creates a contact segment that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success",
"schema":{
"$ref":"#/definitions/ContactSegmentRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contact segments"
],
"x-internal-id":"api-rest-1.0-assets-contact-segment-post",
"x-filename-id":"api-rest-1.0-assets-contact-segment-post"
}
},
"/api/rest/1.0/assets/contact/segment/{id}":{
"get":{
"operationId":"ReadIndividualGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the contact segment.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a contact segment",
"description":"Retrieves the contact segment specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/ContactSegmentRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contact segments"
],
"x-internal-id":"api-rest-1.0-assets-contact-segment-{id}-get",
"x-filename-id":"api-rest-1.0-assets-contact-segment-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the contact segment to be update.",
"required":true,
"schema":{
"$ref":"#/definitions/ContactSegmentRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the contact segment.",
"required":true,
"type":"integer"
}
],
"summary":"Update a contact segment",
"description":"Updates the contact segment specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/ContactSegmentRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contact segments"
],
"x-internal-id":"api-rest-1.0-assets-contact-segment-{id}-put",
"x-filename-id":"api-rest-1.0-assets-contact-segment-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the contact segment.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a contact segment",
"description":"Deletes the contact segment specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contact segments"
],
"x-internal-id":"api-rest-1.0-assets-contact-segment-{id}-delete",
"x-filename-id":"api-rest-1.0-assets-contact-segment-id-delete"
}
},
"/api/rest/1.0/assets/contact/segments":{
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"Unix timestamp for the date and time the contact segment was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of contact segments",
"description":"Retrieves all contact segments that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultSegmentRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Contact segments"
],
"x-internal-id":"api-rest-1.0-assets-contact-segments-get",
"x-filename-id":"api-rest-1.0-assets-contact-segments-get"
}
},
"/api/rest/2.0/assets/form":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the form to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/FormRest20"
}
}
],
"summary":"Create a form",
"description":"Creates a form that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/FormRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Forms"
],
"x-internal-id":"api-rest-2.0-assets-form-post",
"x-filename-id":"api-rest-2.0-assets-form-post"
}
},
"/api/rest/2.0/assets/form/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the form.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a form",
"description":"Retrieves the form specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/FormRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Forms"
],
"x-internal-id":"api-rest-2.0-assets-form-{id}-get",
"x-filename-id":"api-rest-2.0-assets-form-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the form to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/FormRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the form.",
"required":true,
"type":"integer"
}
],
"summary":"Update a form",
"description":"Updates the form specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/FormRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Forms"
],
"x-internal-id":"api-rest-2.0-assets-form-{id}-put",
"x-filename-id":"api-rest-2.0-assets-form-id-put"
},
"patch":{
"operationId":"PatchContentPATCHRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the form for which properties are to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/FormRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the form.",
"required":true,
"type":"integer"
}
],
"summary":"Partially update a form",
"description":"Partially updates the form specified by the id parameter. Only properties included in the request body will be modified.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/FormRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Forms"
],
"x-internal-id":"api-rest-2.0-assets-form-{id}-patch",
"x-filename-id":"api-rest-2.0-assets-form-id-patch"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the form.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a form",
"description":"Deletes the form specified by the id parameter.",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Forms"
],
"x-internal-id":"api-rest-2.0-assets-form-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-form-id-delete"
}
},
"/api/rest/2.0/assets/form/{id}/archive":{
"post":{
"operationId":"ArchiveIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the parameters for archiving the form.",
"required":true,
"schema":{
"$ref":"#/definitions/ArchiveParameterRest20"
}
},
{
"name":"id",
"in":"path",
"description":"ID of the form to be archived.",
"required":true,
"type":"integer"
}
],
"summary":"Archive a form",
"description":"Archives the form specified by the id parameter.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/FormRest20"
}
},
"304":{
"description":"Not Modified. See Status Codes for information about other possible HTTP status codes."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Forms"
],
"x-internal-id":"api-rest-2.0-assets-form-{id}-archive-post",
"x-filename-id":"api-rest-2.0-assets-form-id-archive-post"
}
},
"/api/rest/2.0/assets/form/{id}/unarchive":{
"post":{
"operationId":"UnarchiveIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the parameters for unarchiving the form.",
"required":true,
"schema":{
"$ref":"#/definitions/ArchiveParameterRest20"
}
},
{
"name":"id",
"in":"path",
"description":"ID of the form to be unarchived.",
"required":true,
"type":"integer"
}
],
"summary":"Unarchive a form",
"description":"Unarchives the form specified by the id parameter.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/FormRest20"
}
},
"304":{
"description":"Not Modified. See Status Codes for information about other possible HTTP status codes."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Forms"
],
"x-internal-id":"api-rest-2.0-assets-form-{id}-unarchive-post",
"x-filename-id":"api-rest-2.0-assets-form-id-unarchive-post"
}
},
"/api/rest/2.0/assets/forms":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the form was last updated.",
"required":false,
"type":"integer"
},
{
"name":"includeAvailable",
"in":"query",
"description":"Specifies whether to include unarchived forms in the results, considered true if not specified.",
"required":false,
"type":"boolean"
},
{
"name":"includeArchived",
"in":"query",
"description":"Specifies whether to include archived forms in the results, considered false if not specified.",
"required":false,
"type":"boolean"
}
],
"summary":"Retrieve a list of forms",
"description":"Retrieves all forms that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultFormRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Forms"
],
"x-internal-id":"api-rest-2.0-assets-forms-get",
"x-filename-id":"api-rest-2.0-assets-forms-get"
}
},
"/api/bulk/2.0/activities/exports":{
"get":{
"tags":[
"Bulk/2.0/activities"
],
"summary":"Retrieve a list of activity export definitions",
"description":"Retrieves a list of activity export definitions.",
"operationId":"GetActivityExportSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ActivityExportSearchResponse",
"description":"The response body contains information about the activity export definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/Export"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-activities-exports-get",
"x-filename-id":"api-bulk-2.0-activities-exports-get"
},
"post":{
"tags":[
"Bulk/2.0/activities"
],
"summary":"Create an activity export definition",
"description":"Creates a new activity export definition. After a successful request, the next step is to synchronize the data. See the tutorial for details on how to export data.",
"operationId":"PostActivityExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"ActivityExportIndividual",
"in":"body",
"description":"The request body contains details of the activity export definition.",
"required":true,
"schema":{
"title":"ActivityExportIndividual",
"description":"The request body defines the details of the activity export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"ActivityExportIndividualResponse",
"description":"The response body includes information about the activity export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-activities-exports-post",
"x-filename-id":"api-bulk-2.0-activities-exports-post"
}
},
"/api/bulk/2.0/activities/exports/{id}":{
"get":{
"tags":[
"Bulk/2.0/activities"
],
"summary":"Retrieve an activity export definition",
"description":"Retrieves an activity export definition.",
"operationId":"GetActivityExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the activity export.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ActivityExportIndividualResponse",
"description":"The response body includes information about the activity export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-activities-exports-{id}-get",
"x-filename-id":"api-bulk-2.0-activities-exports-id-get"
},
"put":{
"tags":[
"Bulk/2.0/activities"
],
"summary":"Update an activity export definition",
"description":"Updates an activity export definition.",
"operationId":"PutActivityExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the activity export.",
"required":true,
"type":"integer"
},
{
"name":"ActivityExportIndividual",
"in":"body",
"description":"The request body contains details of the activity export definition.",
"required":true,
"schema":{
"title":"ActivityExportIndividual",
"description":"The request body defines the details of the activity export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ActivityExportIndividualResponse",
"description":"The response body includes information about the activity export definition.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-activities-exports-{id}-put",
"x-filename-id":"api-bulk-2.0-activities-exports-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/activities"
],
"summary":"Delete an activity export definition",
"description":"Deletes an activity export definition.",
"operationId":"DeleteActivityExportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the activity export.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-activities-exports-{id}-delete",
"x-filename-id":"api-bulk-2.0-activities-exports-id-delete"
}
},
"/api/bulk/2.0/activities/exports/{id}/data":{
"get":{
"tags":[
"Bulk/2.0/activities"
],
"summary":"Retrieve an activity export's synced data",
"description":"Retrieves an activity export's synced data.",
"operationId":"GetActivityExportDataQuery",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the activity export.",
"required":true,
"type":"integer"
},
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ActivityExportDataQueryResponse",
"description":"The response body contains information about the synced data.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"type":"object"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-activities-exports-{id}-data-get",
"x-filename-id":"api-bulk-2.0-activities-exports-id-data-get"
},
"delete":{
"tags":[
"Bulk/2.0/activities"
],
"summary":"Delete an activity export definition's data",
"description":"Deletes a specific activity export definition's data.",
"operationId":"DeleteActivityExportDataQuery",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the activity export.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-activities-exports-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-activities-exports-id-data-delete"
}
},
"/api/bulk/2.0/activities/fields/{id}":{
"get":{
"tags":[
"Bulk/2.0/activities"
],
"summary":"Retrieve an activity field definition",
"description":"Retrieves an activity field definition.",
"operationId":"GetActivityFieldIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"Part of the uri used to identify the activity field.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ActivityFieldIndividualResponse",
"description":"The response body contains information about the activity field definition.",
"properties":{
"activityTypes":{
"title":"activityTypes",
"description":"The activity types associated with the activity field. The possible activity types are: EmailSend, EmailOpen, EmailClickthrough, Subscribe, Unsubscribe, Bounceback, WebVisit, PageView, and FormSubmit. See Activity Fields for more information about activity fields.",
"type":"array",
"items":{
"$ref":"#/definitions/ActivityFilterType"
}
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataType":{
"$ref":"#/definitions/DataType"
},
"defaultValue":{
"title":"defaultValue",
"description":"The field's default value.",
"type":"string"
},
"hasNotNullConstraint":{
"title":"hasNotNullConstraint",
"description":"Indicates whether the field can have null values (i.e. empty).",
"type":"boolean"
},
"hasReadOnlyConstraint":{
"title":"hasReadOnlyConstraint",
"description":"Indicates whether the field can be written to.",
"type":"boolean"
},
"hasUniquenessConstraint":{
"title":"hasUniquenessConstraint",
"description":"Indicates whether the field must have a unique value.",
"type":"boolean"
},
"internalName":{
"title":"internalName",
"description":"The field's internal name (used to uniquely identify it).",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the activity definition.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-activities-fields-{id}-get",
"x-filename-id":"api-bulk-2.0-activities-fields-id-get"
}
},
"/api/bulk/2.0/activities/fields":{
"get":{
"tags":[
"Bulk/2.0/activities"
],
"summary":"Retrieve a list of activity field definitions",
"description":"Retrieves a list of activity field definitions.",
"operationId":"GetActivityFieldSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"activityType",
"in":"query",
"description":"The activity type to filter results. Possible values include: EmailOpen, EmailClickthrough, EmailSend, Subscribe, Unsubscribe, Bounceback, WebVisit, PageView, and FormSubmit. Refer to Activity Fields for a list of activity fields for each activity type.",
"type":"string"
},
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ActivityFieldSearchResponse",
"description":"The response body contains information about the activity field definitions.",
"properties":{
"count":{
"title":"count",
"description":"The number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/ActivityField"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-activities-fields-get",
"x-filename-id":"api-bulk-2.0-activities-fields-get"
}
},
"/api/bulk/2.0/activities/imports":{
"get":{
"tags":[
"Bulk/2.0/activities"
],
"summary":"Retrieve a list of activity import definitions",
"description":"Retrieves a list of activity import definitions.",
"operationId":"GetActivityImportSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ActivityImportSearchResponse",
"description":"The response body contains information about account import definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items that match the search.",
"type":"array",
"items":{
"$ref":"#/definitions/Import"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-activities-imports-get",
"x-filename-id":"api-bulk-2.0-activities-imports-get"
},
"post":{
"tags":[
"Bulk/2.0/activities"
],
"summary":"Create an activity import definition",
"description":"Creates a new activity import definition to be used to import external activities related to external assets only. See the tutorial for details on how to import data.",
"operationId":"PostActivityImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"ActivityImportIndividual",
"in":"body",
"description":"The request body contains details of the activity import defintion.",
"required":true,
"schema":{
"title":"ActivityImportIndividual",
"description":"The request body defines the details of the activity import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"Success.",
"schema":{
"title":"ActivityImportIndividualResponse",
"description":"The response body includes information about the activity import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-activities-imports-post",
"x-filename-id":"api-bulk-2.0-activities-imports-post"
}
},
"/api/bulk/2.0/activities/imports/{id}":{
"get":{
"tags":[
"Bulk/2.0/activities"
],
"summary":"Retrieve an activity import definition",
"description":"Retrieves an activity import definition.",
"operationId":"GetActivityImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The activity import definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ActivityImportIndividualResponse",
"description":"The response body includes information about the activity import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-activities-imports-{id}-get",
"x-filename-id":"api-bulk-2.0-activities-imports-id-get"
},
"put":{
"tags":[
"Bulk/2.0/activities"
],
"summary":"Update an activity import definition",
"description":"Updates an activity import definition.",
"operationId":"PutActivityImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The activity import definition's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"ActivityImportIndividual",
"in":"body",
"description":"The request body contains details of the activity import defintion.",
"required":true,
"schema":{
"title":"ActivityImportIndividual",
"description":"The request body defines the details of the activity import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"ActivityImportIndividualResponse",
"description":"The response body includes information about the activity import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-activities-imports-{id}-put",
"x-filename-id":"api-bulk-2.0-activities-imports-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/activities"
],
"summary":"Delete an activity import definition",
"description":"Deletes an activity import definition.",
"operationId":"DeleteActivityImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The activity import definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-activities-imports-{id}-delete",
"x-filename-id":"api-bulk-2.0-activities-imports-id-delete"
}
},
"/api/bulk/2.0/activities/imports/{id}/data":{
"post":{
"tags":[
"Bulk/2.0/activities"
],
"summary":"Upload data for a specified activity import definition",
"description":"Uploads data for a specified activity import definition. When uploading data, Eloqua expects that data to be encoded with UTF-8.",
"operationId":"PostActivityImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The activity import definition's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"ActivityImportData",
"in":"body",
"description":"The request body contains data to be uploaded to the activity import definition.",
"required":true,
"schema":{
"title":"ActivityImportData",
"type":"array",
"items":{
"title":"ActivityImportDataItem",
"type":"object",
"items":{
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"OK.",
"schema":{
"title":"ActivityImportDataResponse",
"description":"Sync response when POSTing activity import data, and isSyncTriggeredOnImport = true on the import definition.",
"properties":{
"callbackUrl":{
"title":"callbackUrl",
"description":"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.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"status":{
"$ref":"#/definitions/SyncStatusType"
},
"syncedInstanceUri":{
"title":"syncedInstanceUri",
"description":"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.",
"type":"string"
},
"syncEndedAt":{
"format":"date-time",
"title":"syncEndedAt",
"description":"The date and time the sync ended. This is a read-only property.",
"type":"string"
},
"syncStartedAt":{
"format":"date-time",
"title":"syncStartedAt",
"description":"The date and time the sync started. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"204":{
"description":"No content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-activities-imports-{id}-data-post",
"x-filename-id":"api-bulk-2.0-activities-imports-id-data-post"
},
"delete":{
"tags":[
"Bulk/2.0/activities"
],
"summary":"Delete an activity import definition's data",
"description":"Deletes an activity import definition's data.",
"operationId":"DeleteActivityImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The activity import definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-activities-imports-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-activities-imports-id-data-delete"
}
},
"/api/rest/2.0/assets/email/folder":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the folder to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest20"
}
}
],
"summary":"Create a folder",
"description":"Creates a folder that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Email folders"
],
"x-internal-id":"api-rest-2.0-assets-email-folder-post",
"x-filename-id":"api-rest-2.0-assets-email-folder-post"
}
},
"/api/rest/2.0/assets/email/folder/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a folder",
"description":"Retrieves the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Email folders"
],
"x-internal-id":"api-rest-2.0-assets-email-folder-{id}-get",
"x-filename-id":"api-rest-2.0-assets-email-folder-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the folder to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
}
],
"summary":"Update a folder",
"description":"The request body defines the details of the folder to be updated.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Email folders"
],
"x-internal-id":"api-rest-2.0-assets-email-folder-{id}-put",
"x-filename-id":"api-rest-2.0-assets-email-folder-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a folder",
"description":"Deletes the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Email folders"
],
"x-internal-id":"api-rest-2.0-assets-email-folder-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-email-folder-id-delete"
}
},
"/api/rest/2.0/assets/email/folders":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
},
{
"name":"includeAvailable",
"in":"query",
"description":"Specifies whether to include unarchived emails in the results, considered true if not specified.",
"required":false,
"type":"boolean"
},
{
"name":"includeArchived",
"in":"query",
"description":"Specifies whether to include archived emails in the results, considered false if not specified.",
"required":false,
"type":"boolean"
}
],
"summary":"Retrieve a list of folders",
"description":"Retrieves all folders that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Email folders"
],
"x-internal-id":"api-rest-2.0-assets-email-folders-get",
"x-filename-id":"api-rest-2.0-assets-email-folders-get"
}
},
"/api/rest/2.0/assets/email/folder/{id}/contents":{
"get":{
"operationId":"SearchContentsGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of folder contents",
"description":"Retrieves all folder contents that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContractObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Email folders"
],
"x-internal-id":"api-rest-2.0-assets-email-folder-{id}-contents-get",
"x-filename-id":"api-rest-2.0-assets-email-folder-id-contents-get"
},
"patch":{
"operationId":"BatchMovePATCHRest20",
"parameters":[
{
"name":"contents",
"in":"body",
"description":"The contents to place in the folder.",
"required":true,
"items":{
"$ref":"#/definitions/MinimalRest20"
},
"schema":{
"type":"array"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
}
],
"summary":"Add content to a folder",
"description":"Places all content into the folder specified by the id parameter.",
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/MinimalRest20"
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Email folders"
],
"x-internal-id":"api-rest-2.0-assets-email-folder-{id}-contents-patch",
"x-filename-id":"api-rest-2.0-assets-email-folder-id-contents-patch"
}
},
"/api/rest/2.0/assets/email/folder/root/contents":{
"get":{
"operationId":"SearchRootContentsGETRest20",
"parameters":[
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of folder contents in the root folder",
"description":"Retrieves all folder contents in the root folder that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultContractObjectRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Email folders"
],
"x-internal-id":"api-rest-2.0-assets-email-folder-root-contents-get",
"x-filename-id":"api-rest-2.0-assets-email-folder-root-contents-get"
}
},
"/api/rest/2.0/assets/email/folder/root":{
"get":{
"operationId":"ReadRootFolderGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve the root folder",
"description":"Retrieves the root folder.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/FolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Email folders"
],
"x-internal-id":"api-rest-2.0-assets-email-folder-root-get",
"x-filename-id":"api-rest-2.0-assets-email-folder-root-get"
}
},
"/api/rest/2.0/assets/email/folder/root/folders":{
"get":{
"operationId":"SearchRootSubFoldersGETRest20",
"parameters":[
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of subfolders in the root folder",
"description":"Retrieves all subfolders in the root folder that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Email folders"
],
"x-internal-id":"api-rest-2.0-assets-email-folder-root-folders-get",
"x-filename-id":"api-rest-2.0-assets-email-folder-root-folders-get"
}
},
"/api/rest/2.0/assets/email/folder/{id}/folders":{
"get":{
"operationId":"SearchSubFoldersGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the folder.",
"required":true,
"type":"integer"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"The date and time the email was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of subfolders",
"description":"Retrieves all subfolders that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/QueryResultFolderRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Email folders"
],
"x-internal-id":"api-rest-2.0-assets-email-folder-{id}-folders-get",
"x-filename-id":"api-rest-2.0-assets-email-folder-id-folders-get"
}
},
"/API/OData/CampaignAnalysis/1/Calendar":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/Calendar"
],
"summary":"Get all Calendars",
"operationId":"Calendar_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Calendars successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Calendar"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-Calendar-get",
"x-filename-id":"api-odata-campaignanalysis-1-calendar-get"
}
},
"/API/OData/CampaignAnalysis/1/Campaign":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/Campaign"
],
"summary":"Get all Campaigns",
"operationId":"Campaign_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Campaigns successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Campaign"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-Campaign-get",
"x-filename-id":"api-odata-campaignanalysis-1-campaign-get"
}
},
"/API/OData/CampaignAnalysis/1/Campaign/{key}":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/Campaign"
],
"summary":"Get a single Campaign",
"operationId":"Campaign_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"CampaignID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Campaign was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Campaign"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-Campaign-{key}-get",
"x-filename-id":"api-odata-campaignanalysis-1-campaign-key-get"
}
},
"/API/OData/CampaignAnalysis/1/Campaign/{key}/WebActivities":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/Campaign"
],
"summary":"Get web activities for a specified campaign",
"operationId":"Campaign_GetWebActivities",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"CampaignID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"WebActivities were successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/WebActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-Campaign-{key}-WebActivities-get",
"x-filename-id":"api-odata-campaignanalysis-1-campaign-key-webactivities-get"
}
},
"/API/OData/CampaignAnalysis/1/Campaign/{key}/FormActivities":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/Campaign"
],
"summary":"Get form activities for a specified campaign",
"operationId":"Campaign_GetFormActivities",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"CampaignID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"FormActivities were successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/FormActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-Campaign-{key}-FormActivities-get",
"x-filename-id":"api-odata-campaignanalysis-1-campaign-key-formactivities-get"
}
},
"/API/OData/CampaignAnalysis/1/Campaign/{key}/LeadActivities":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/Campaign"
],
"summary":"Get lead activities for a specified campaign",
"operationId":"Campaign_GetLeadActivities",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"CampaignID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"LeadActivities were successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/LeadActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-Campaign-{key}-LeadActivities-get",
"x-filename-id":"api-odata-campaignanalysis-1-campaign-key-leadactivities-get"
}
},
"/API/OData/CampaignAnalysis/1/Campaign/{key}/EmailActivities":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/Campaign"
],
"summary":"Get email activities for a specified campaign",
"operationId":"Campaign_GetEmailActivities",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"CampaignID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-Campaign-{key}-EmailActivities-get",
"x-filename-id":"api-odata-campaignanalysis-1-campaign-key-emailactivities-get"
}
},
"/API/OData/CampaignAnalysis/1/Campaign/{key}/LandingPageActivities":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/Campaign"
],
"summary":"Get landing page activities for a specified campaign",
"operationId":"Campaign_GetLandingPageActivities",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"CampaignID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"LandingPageActivities were successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/LandingPageActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-Campaign-{key}-LandingPageActivities-get",
"x-filename-id":"api-odata-campaignanalysis-1-campaign-key-landingpageactivities-get"
}
},
"/API/OData/CampaignAnalysis/1/EmailActivities":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/EmailActivities"
],
"summary":"Get all Email Activities",
"description":"Email activity must have occured over the past 25 months",
"operationId":"EmailActivities_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailActivities successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-EmailActivities-get",
"x-filename-id":"api-odata-campaignanalysis-1-emailactivities-get"
}
},
"/API/OData/CampaignAnalysis/1/EmailActivities/{key}":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/EmailActivities"
],
"summary":"Get a single Email Activity",
"description":"Email activity must have occured over the past 25 months",
"operationId":"EmailActivities_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"EmailActivitiesID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailActivity was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-EmailActivities-{key}-get",
"x-filename-id":"api-odata-campaignanalysis-1-emailactivities-key-get"
}
},
"/API/OData/CampaignAnalysis/1/EmailAsset":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/EmailAsset"
],
"summary":"Get all Email Assets",
"operationId":"EmailAsset_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailAssets successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailAsset"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-EmailAsset-get",
"x-filename-id":"api-odata-campaignanalysis-1-emailasset-get"
}
},
"/API/OData/CampaignAnalysis/1/EmailAsset/{key}":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/EmailAsset"
],
"summary":"Get a single Email Asset",
"operationId":"EmailAsset_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"EmailAssetID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailAsset was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailAsset"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-EmailAsset-{key}-get",
"x-filename-id":"api-odata-campaignanalysis-1-emailasset-key-get"
}
},
"/API/OData/CampaignAnalysis/1/EmailAsset/{key}/EmailActivities":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/EmailAsset"
],
"summary":"Get Email activities for a specified Email Asset",
"operationId":"EmailAsset_GetEmailActivities",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"EmailAssetID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailActivities were successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-EmailAsset-{key}-EmailActivities-get",
"x-filename-id":"api-odata-campaignanalysis-1-emailasset-key-emailactivities-get"
}
},
"/API/OData/CampaignAnalysis/1/ExternalActivityTotals":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/ExternalActivityTotals"
],
"summary":"Get all External Activity Totals.",
"operationId":"ExternalActivityTotals_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"ExternalActivityTotals successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/ExternalActivityTotals"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-ExternalActivityTotals-get",
"x-filename-id":"api-odata-campaignanalysis-1-externalactivitytotals-get"
}
},
"/API/OData/CampaignAnalysis/1/FormActivities":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/FormActivities"
],
"summary":"Get all Form Activities",
"operationId":"FormActivities_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"FormActivities successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/FormActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-FormActivities-get",
"x-filename-id":"api-odata-campaignanalysis-1-formactivities-get"
}
},
"/API/OData/CampaignAnalysis/1/FormActivities/{key}":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/FormActivities"
],
"summary":"Get a single Form Activities",
"operationId":"FormActivitiest_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"FormActivitiesID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"FormActivities was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/FormActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-FormActivities-{key}-get",
"x-filename-id":"api-odata-campaignanalysis-1-formactivities-key-get"
}
},
"/API/OData/CampaignAnalysis/1/LandingPageActivities":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/LandingPageActivities"
],
"summary":"Get all Landing Page Activities.",
"operationId":"LandingPageActivities_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"LandingPageActivities successfully retrieved.",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/LandingPageActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-LandingPageActivities-get",
"x-filename-id":"api-odata-campaignanalysis-1-landingpageactivities-get"
}
},
"/API/OData/CampaignAnalysis/1/LandingPageActivities/{key}":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/LandingPageActivities"
],
"summary":"Get a single Landing Page Activity",
"operationId":"LandingPageActivities_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"LandingPageActivityID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"LandingPageActivity was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/LandingPageActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-LandingPageActivities-{key}-get",
"x-filename-id":"api-odata-campaignanalysis-1-landingpageactivities-key-get"
}
},
"/API/OData/CampaignAnalysis/1/LandingPageAsset":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/LandingPageAsset"
],
"summary":"Get all Landing Page Assets",
"operationId":"LandingPageAsset_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"LandingPageAssets successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/LandingPageAsset"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-LandingPageAsset-get",
"x-filename-id":"api-odata-campaignanalysis-1-landingpageasset-get"
}
},
"/API/OData/CampaignAnalysis/1/LandingPageAsset/{key}":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/LandingPageAsset"
],
"summary":"Get a single Landing Page Asset",
"operationId":"LandingPageAsset_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"LandingPageAssetsID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"LandingPageAssets was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/LandingPageAsset"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-LandingPageAsset-{key}-get",
"x-filename-id":"api-odata-campaignanalysis-1-landingpageasset-key-get"
}
},
"/API/OData/CampaignAnalysis/1/LandingPageAsset/{key}/LandingPageActivities":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/LandingPageAsset"
],
"summary":"Get Landing Page Activities for a specified Landing Page Asset",
"operationId":"LandingPageAsset_GetLandingPageActivities",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"LandingPageAssetsID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"LandingPageActivities were successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/LandingPageActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-LandingPageAsset-{key}-LandingPageActivities-get",
"x-filename-id":"api-odata-campaignanalysis-1-landingpageasset-key-landingpageactivities-get"
}
},
"/API/OData/CampaignAnalysis/1/LeadActivities":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/LeadActivities"
],
"summary":"Get all Lead Activities",
"operationId":"LeadActivities_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"LeadActivities successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/LeadActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-LeadActivities-get",
"x-filename-id":"api-odata-campaignanalysis-1-leadactivities-get"
}
},
"/API/OData/CampaignAnalysis/1/MarketingActivities":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/MarketingActivities"
],
"summary":"Get all Marketing Activities",
"operationId":"MarketingActivities_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"MarketingActivities successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/MarketingActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-MarketingActivities-get",
"x-filename-id":"api-odata-campaignanalysis-1-marketingactivities-get"
}
},
"/API/OData/CampaignAnalysis/1/MarketingActivities/{key}":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/MarketingActivities"
],
"summary":"Get a single Marketing Activity",
"operationId":"MarketingActivities_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"MarketingActivityID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"MarketingActivity was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/MarketingActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-MarketingActivities-{key}-get",
"x-filename-id":"api-odata-campaignanalysis-1-marketingactivities-key-get"
}
},
"/API/OData/CampaignAnalysis/1/Segment":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/Segment"
],
"summary":"Get all Segments",
"operationId":"Segment_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Segments successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Segment"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-Segment-get",
"x-filename-id":"api-odata-campaignanalysis-1-segment-get"
}
},
"/API/OData/CampaignAnalysis/1/Segment/{key}":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/Segment"
],
"summary":"Get a single Segment",
"operationId":"Segment_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"SegmentID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Segment was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Segment"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-Segment-{key}-get",
"x-filename-id":"api-odata-campaignanalysis-1-segment-key-get"
}
},
"/API/OData/CampaignAnalysis/1/Segment/{key}/FormActivities":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/Segment"
],
"summary":"Get Form Activities for a specified segment",
"operationId":"Segment_GetFormActivities",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"SegmentID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"FormActivities were successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/FormActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-Segment-{key}-FormActivities-get",
"x-filename-id":"api-odata-campaignanalysis-1-segment-key-formactivities-get"
}
},
"/API/OData/CampaignAnalysis/1/Segment/{key}/EmailActivities":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/Segment"
],
"summary":"Get Email Activities for a specified segment",
"operationId":"Segment_GetEmailActivities",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"SegmentID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailActivities were successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-Segment-{key}-EmailActivities-get",
"x-filename-id":"api-odata-campaignanalysis-1-segment-key-emailactivities-get"
}
},
"/API/OData/CampaignAnalysis/1/User":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/User"
],
"summary":"Get all Users",
"operationId":"User_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Users successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/User"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-User-get",
"x-filename-id":"api-odata-campaignanalysis-1-user-get"
}
},
"/API/OData/CampaignAnalysis/1/User/{key}":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/User"
],
"summary":"Get a single User",
"operationId":"User_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"User",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"User was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/User"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-User-{key}-get",
"x-filename-id":"api-odata-campaignanalysis-1-user-key-get"
}
},
"/API/OData/CampaignAnalysis/1/User/{key}/Segments":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/User"
],
"summary":"Get Segments for a specified user",
"operationId":"User_GetSegments",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"UserID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Segment were successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Segment"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-User-{key}-Segments-get",
"x-filename-id":"api-odata-campaignanalysis-1-user-key-segments-get"
}
},
"/API/OData/CampaignAnalysis/1/User/{key}/Campaigns":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/User"
],
"summary":"Get campaigns for a specified user",
"operationId":"User_GetCampaigns",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"UserID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"Campaigns were successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/Campaign"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-User-{key}-Campaigns-get",
"x-filename-id":"api-odata-campaignanalysis-1-user-key-campaigns-get"
}
},
"/API/OData/CampaignAnalysis/1/User/{key}/EmailAssets":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/User"
],
"summary":"Get Email Assets for a specified user",
"operationId":"User_GetEmailAssets",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"UserID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"EmailAssets were successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/EmailAsset"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-User-{key}-EmailAssets-get",
"x-filename-id":"api-odata-campaignanalysis-1-user-key-emailassets-get"
}
},
"/API/OData/CampaignAnalysis/1/WebActivities":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/WebActivities"
],
"summary":"Get all Web Activities",
"operationId":"WebActivities_Get",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"WebActivities successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/WebActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-WebActivities-get",
"x-filename-id":"api-odata-campaignanalysis-1-webactivities-get"
}
},
"/API/OData/CampaignAnalysis/1/WebActivities/{key}":{
"get":{
"tags":[
"Reporting/CampaignAnalysis/1.0/WebActivities"
],
"summary":"Get a single Web Activity",
"operationId":"WebActivities_Get_By_ID",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"key",
"in":"path",
"description":"WebActivitiesID",
"required":true,
"type":"integer",
"format":"int32"
},
{
"name":"$select",
"in":"query",
"description":"Limits the properties returned in the result.",
"required":false,
"type":"string"
},
{
"name":"$expand",
"in":"query",
"description":"Indicates the related entities to be represented inline. The maximum depth is 2.",
"required":false,
"type":"string"
},
{
"name":"$filter",
"in":"query",
"description":"Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.",
"required":false,
"type":"string"
},
{
"name":"$orderby",
"in":"query",
"description":"Specifies the order in which items are returned. The maximum number of expressions is 5.",
"required":false,
"type":"string"
},
{
"name":"$top",
"in":"query",
"description":"Limits the number of items returned from a collection. The maximum value is 20000.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$skip",
"in":"query",
"description":"Excludes the specified number of items of the queried collection from the result.",
"required":false,
"type":"integer",
"format":"int32"
},
{
"name":"$count",
"in":"query",
"description":"Indicates whether the total count of items within a collection are returned in the result.",
"required":false,
"type":"boolean",
"default":false
}
],
"responses":{
"200":{
"description":"WebActivities was successfully retrieved",
"schema":{
"type":"array",
"items":{
"$ref":"#/definitions/WebActivities"
}
}
}
},
"x-internal-id":"API-OData-CampaignAnalysis-1-WebActivities-{key}-get",
"x-filename-id":"api-odata-campaignanalysis-1-webactivities-key-get"
}
},
"/api/rest/2.0/assets/email/signature/rule/{id}":{
"get":{
"operationId":"ReadIndividualGETRest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the signature rule to retrieve.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve a signature rule",
"description":"Retrieves the signature rule specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/EmailSignatureRuleRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Signature Rules"
],
"x-internal-id":"api-rest-2.0-assets-email-signature-rule-{id}-get",
"x-filename-id":"api-rest-2.0-assets-email-signature-rule-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the signature rule to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/EmailSignatureRuleRest20"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the signature rule to update.",
"required":true,
"type":"integer"
}
],
"summary":"Update a signature rule",
"description":"Updates the signature rule specified by the id parameter.\r\nAll properties should be included in PUT requests, as some properties will be considered blank if not included.\r\nThe settings for contactFieldId, customObjectFieldId , and eventRegistrationId are exclusive. Providing more than one of these values will result in an error.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/EmailSignatureRuleRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Signature Rules"
],
"x-internal-id":"api-rest-2.0-assets-email-signature-rule-{id}-put",
"x-filename-id":"api-rest-2.0-assets-email-signature-rule-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest20",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the signature rule to delete.",
"required":true,
"type":"integer"
}
],
"summary":"Delete a signature rule",
"description":"Deletes a signature rule specified by the id parameter.",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Signature Rules"
],
"x-internal-id":"api-rest-2.0-assets-email-signature-rule-{id}-delete",
"x-filename-id":"api-rest-2.0-assets-email-signature-rule-id-delete"
}
},
"/api/rest/2.0/assets/email/signature/rules":{
"get":{
"operationId":"SearchGETRest20",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered, and the direction. The direction will default to ASC if not specified. See the URL parameters for information.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"Unix timestamp for the date and time the external asset was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of signature rules",
"description":"Retrieves all signature rules that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultRuleRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Signature Rules"
],
"x-internal-id":"api-rest-2.0-assets-email-signature-rules-get",
"x-filename-id":"api-rest-2.0-assets-email-signature-rules-get"
}
},
"/api/rest/2.0/assets/email/signature/rule":{
"post":{
"operationId":"CreateIndividualPOSTRest20",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the signature rule to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/EmailSignatureRuleRest20"
}
}
],
"summary":"Create a signature rule",
"description":"Creates a signature rule with the provided settings.\r\nThe settings for contactFieldId, customObjectFieldId , and eventRegistrationId are exclusive. Providing more than one of these values will result in an error.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/EmailSignatureRuleRest20"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/2.0/Signature Rules"
],
"x-internal-id":"api-rest-2.0-assets-email-signature-rule-post",
"x-filename-id":"api-rest-2.0-assets-email-signature-rule-post"
}
},
"/api/rest/1.0/assets/email/footer":{
"post":{
"operationId":"CreateIndividualPOSTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the email footer to be created.",
"required":true,
"schema":{
"$ref":"#/definitions/EmailFooterRest10"
}
}
],
"summary":"Create an email footer",
"description":"Creates an email footer that matches the criteria specified by the request body.",
"responses":{
"201":{
"description":"Success.",
"schema":{
"$ref":"#/definitions/EmailFooterRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email footers"
],
"x-internal-id":"api-rest-1.0-assets-email-footer-post",
"x-filename-id":"api-rest-1.0-assets-email-footer-post"
}
},
"/api/rest/1.0/assets/email/footer/{id}":{
"get":{
"operationId":"ReadIndividualGETRest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the email footer.",
"required":true,
"type":"integer"
},
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.",
"required":false,
"type":"string"
}
],
"summary":"Retrieve an email footer",
"description":"Retrieves the email footer specified by the id parameter.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/EmailFooterRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email footers"
],
"x-internal-id":"api-rest-1.0-assets-email-footer-{id}-get",
"x-filename-id":"api-rest-1.0-assets-email-footer-id-get"
},
"put":{
"operationId":"UpdateIndividualPUTRest10",
"parameters":[
{
"name":"message",
"in":"body",
"description":"The request body defines the details of the email footer to be updated.",
"required":true,
"schema":{
"$ref":"#/definitions/EmailFooterRest10"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the email footer to update.",
"required":true,
"type":"integer"
}
],
"summary":"Update an email footer",
"description":"Updates the email footer specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/EmailFooterRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email footers"
],
"x-internal-id":"api-rest-1.0-assets-email-footer-{id}-put",
"x-filename-id":"api-rest-1.0-assets-email-footer-id-put"
},
"delete":{
"operationId":"DeleteIndividualDELETERest10",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the email footer to delete.",
"required":true,
"type":"integer"
}
],
"summary":"Delete an email footer",
"description":"Deletes the email footer specified by the id parameter.",
"responses":{
"200":{
"description":"OK."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email footers"
],
"x-internal-id":"api-rest-1.0-assets-email-footer-{id}-delete",
"x-filename-id":"api-rest-1.0-assets-email-footer-id-delete"
}
},
"/api/rest/1.0/assets/email/footers":{
"get":{
"operationId":"SearchGETRest10",
"parameters":[
{
"name":"depth",
"in":"query",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.",
"required":false,
"type":"string"
},
{
"name":"count",
"in":"query",
"description":"Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.",
"required":false,
"type":"integer"
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"type":"integer"
},
{
"name":"search",
"in":"query",
"description":"Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.",
"required":false,
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the field by which list results are ordered.",
"required":false,
"type":"string"
},
{
"name":"lastUpdatedAt",
"in":"query",
"description":"Unix timestamp for the date and time the email footer was last updated.",
"required":false,
"type":"integer"
}
],
"summary":"Retrieve a list of email footers",
"description":"Retrieves all email footers that match the criteria specified by the request parameters.",
"responses":{
"200":{
"description":"OK.",
"schema":{
"$ref":"#/definitions/QueryResultFooterRest10"
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an error. See Status Codes for information about other possible HTTP status codes."
}
},
"tags":[
"Application/1.0/Email footers"
],
"x-internal-id":"api-rest-1.0-assets-email-footers-get",
"x-filename-id":"api-rest-1.0-assets-email-footers-get"
}
},
"/api/bulk/2.0/opportunities/contacts/imports":{
"get":{
"tags":[
"Bulk/2.0/opportunities"
],
"summary":"Retrieve a list of opportunity contact linkage import definitions",
"description":"Retrieves a list of opportunity contact linkage import definitions. For more information about using these endpoints, see, using the opportunities endpoints.",
"operationId":"GetOpportunityContactLinkageImportSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"OpportunityContactLinkageImportSearchResponse",
"description":"The response body contains information about the opportunity contact linkage import definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items returned.",
"type":"array",
"items":{
"$ref":"#/definitions/Import"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-opportunities-contacts-imports-get",
"x-filename-id":"api-bulk-2.0-opportunities-contacts-imports-get"
},
"post":{
"tags":[
"Bulk/2.0/opportunities"
],
"summary":"Create an opportunity contact linkage import definition",
"description":"Creates an opportunity contact linkage import definition. For more information about using these endpoints, see, using the opportunities endpoints.",
"operationId":"PostOpportunityContactLinkageImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"OpportunityContactLinkageImportIndividual",
"in":"body",
"description":"The request body contains details of the opportunity contact linkage import definition.",
"required":true,
"schema":{
"title":"OpportunityContactLinkageImportIndividual",
"description":"The request body defines details of the opportunity contact linkage import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"linkOpportunitiesCaseSensitiveMatchField":{
"title":"linkOpportunitiesCaseSensitiveMatchField",
"description":"Whether or not to perform a case sensitive search on the match field.",
"type":"boolean"
},
"linkOpportunitiesCaseSensitiveSourceField":{
"title":"linkOpportunitiesCaseSensitiveSourceField",
"description":"Whether or not to perform a case sensitive search on the source field.",
"type":"boolean"
},
"linkOpportunitiesEntityType":{
"title":"linkOpportunitiesEntityType",
"description":"Specifies the entity of the contact linkage import. Allowed values are \"Contact\" or \"Account\".",
"type":"string"
},
"linkOpportunitiesMatchFieldName":{
"title":"linkOpportunitiesMatchFieldName",
"description":"Specifies the field name for matching.",
"type":"string"
},
"linkOpportunitiesMultipleSourceMatches":{
"title":"linkOpportunitiesMultipleSourceMatches",
"description":"Whether or not imported data will be mapped to multiple matching records.",
"type":"boolean"
},
"linkOpportunitiesSourceField":{
"title":"linkOpportunitiesSourceField",
"description":"Specifies the source field name for matching.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"OK.",
"schema":{
"title":"OpportunityContactLinkageImportIndividualResponse",
"description":"The response body includes information about the opportunity contact linkage import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"linkOpportunitiesCaseSensitiveMatchField":{
"title":"linkOpportunitiesCaseSensitiveMatchField",
"description":"Whether or not to perform a case sensitive search on the match field.",
"type":"boolean"
},
"linkOpportunitiesCaseSensitiveSourceField":{
"title":"linkOpportunitiesCaseSensitiveSourceField",
"description":"Whether or not to perform a case sensitive search on the source field.",
"type":"boolean"
},
"linkOpportunitiesEntityType":{
"title":"linkOpportunitiesEntityType",
"description":"Specifies the entity of the contact linkage import. Allowed values are \"Contact\" or \"Account\".",
"type":"string"
},
"linkOpportunitiesMatchFieldName":{
"title":"linkOpportunitiesMatchFieldName",
"description":"Specifies the field name for matching.",
"type":"string"
},
"linkOpportunitiesMultipleSourceMatches":{
"title":"linkOpportunitiesMultipleSourceMatches",
"description":"Whether or not imported data will be mapped to multiple matching records.",
"type":"boolean"
},
"linkOpportunitiesSourceField":{
"title":"linkOpportunitiesSourceField",
"description":"Specifies the source field name for matching.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-opportunities-contacts-imports-post",
"x-filename-id":"api-bulk-2.0-opportunities-contacts-imports-post"
}
},
"/api/bulk/2.0/opportunities/contacts/imports/{id}":{
"get":{
"tags":[
"Bulk/2.0/opportunities"
],
"summary":"Retrieve an opportunity contact linkage import definition",
"description":"Retrieves an opportunity contact linkage import definition. For more information about using these endpoints, see, using the opportunities endpoints.",
"operationId":"GetOpportunityContactLinkageImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The opportunity contact linkage import definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"OpportunityContactLinkageImportIndividualResponse",
"description":"The response body includes information about the opportunity contact linkage import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"linkOpportunitiesCaseSensitiveMatchField":{
"title":"linkOpportunitiesCaseSensitiveMatchField",
"description":"Whether or not to perform a case sensitive search on the match field.",
"type":"boolean"
},
"linkOpportunitiesCaseSensitiveSourceField":{
"title":"linkOpportunitiesCaseSensitiveSourceField",
"description":"Whether or not to perform a case sensitive search on the source field.",
"type":"boolean"
},
"linkOpportunitiesEntityType":{
"title":"linkOpportunitiesEntityType",
"description":"Specifies the entity of the contact linkage import. Allowed values are \"Contact\" or \"Account\".",
"type":"string"
},
"linkOpportunitiesMatchFieldName":{
"title":"linkOpportunitiesMatchFieldName",
"description":"Specifies the field name for matching.",
"type":"string"
},
"linkOpportunitiesMultipleSourceMatches":{
"title":"linkOpportunitiesMultipleSourceMatches",
"description":"Whether or not imported data will be mapped to multiple matching records.",
"type":"boolean"
},
"linkOpportunitiesSourceField":{
"title":"linkOpportunitiesSourceField",
"description":"Specifies the source field name for matching.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-opportunities-contacts-imports-{id}-get",
"x-filename-id":"api-bulk-2.0-opportunities-contacts-imports-id-get"
},
"put":{
"tags":[
"Bulk/2.0/opportunities"
],
"summary":"Update an opportunity contact linkage import definition",
"description":"Updates an opportunity contact linkage import definition. For more information about using these endpoints, see, using the opportunities endpoints.",
"operationId":"PutOpportunityContactLinkageImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The opportunity contact linkage import definition's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"OpportunityContactLinkageImportIndividual",
"in":"body",
"description":"The request body contains details of the opportunity contact linkage import definition.",
"required":true,
"schema":{
"title":"OpportunityContactLinkageImportIndividual",
"description":"The request body defines details of the opportunity contact linkage import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"linkOpportunitiesCaseSensitiveMatchField":{
"title":"linkOpportunitiesCaseSensitiveMatchField",
"description":"Whether or not to perform a case sensitive search on the match field.",
"type":"boolean"
},
"linkOpportunitiesCaseSensitiveSourceField":{
"title":"linkOpportunitiesCaseSensitiveSourceField",
"description":"Whether or not to perform a case sensitive search on the source field.",
"type":"boolean"
},
"linkOpportunitiesEntityType":{
"title":"linkOpportunitiesEntityType",
"description":"Specifies the entity of the contact linkage import. Allowed values are \"Contact\" or \"Account\".",
"type":"string"
},
"linkOpportunitiesMatchFieldName":{
"title":"linkOpportunitiesMatchFieldName",
"description":"Specifies the field name for matching.",
"type":"string"
},
"linkOpportunitiesMultipleSourceMatches":{
"title":"linkOpportunitiesMultipleSourceMatches",
"description":"Whether or not imported data will be mapped to multiple matching records.",
"type":"boolean"
},
"linkOpportunitiesSourceField":{
"title":"linkOpportunitiesSourceField",
"description":"Specifies the source field name for matching.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"OpportunityContactLinkageImportIndividualResponse",
"description":"The response body includes information about the opportunity contact linkage import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"linkOpportunitiesCaseSensitiveMatchField":{
"title":"linkOpportunitiesCaseSensitiveMatchField",
"description":"Whether or not to perform a case sensitive search on the match field.",
"type":"boolean"
},
"linkOpportunitiesCaseSensitiveSourceField":{
"title":"linkOpportunitiesCaseSensitiveSourceField",
"description":"Whether or not to perform a case sensitive search on the source field.",
"type":"boolean"
},
"linkOpportunitiesEntityType":{
"title":"linkOpportunitiesEntityType",
"description":"Specifies the entity of the contact linkage import. Allowed values are \"Contact\" or \"Account\".",
"type":"string"
},
"linkOpportunitiesMatchFieldName":{
"title":"linkOpportunitiesMatchFieldName",
"description":"Specifies the field name for matching.",
"type":"string"
},
"linkOpportunitiesMultipleSourceMatches":{
"title":"linkOpportunitiesMultipleSourceMatches",
"description":"Whether or not imported data will be mapped to multiple matching records.",
"type":"boolean"
},
"linkOpportunitiesSourceField":{
"title":"linkOpportunitiesSourceField",
"description":"Specifies the source field name for matching.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-opportunities-contacts-imports-{id}-put",
"x-filename-id":"api-bulk-2.0-opportunities-contacts-imports-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/opportunities"
],
"summary":"Delete an opportunity contact linkage import definition",
"description":"Deletes an opportunity contact linkage import definition. For more information about using these endpoints, see, using the opportunities endpoints.",
"operationId":"DeleteOpportunityContactLinkageImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The opportunity contact linkage import definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-opportunities-contacts-imports-{id}-delete",
"x-filename-id":"api-bulk-2.0-opportunities-contacts-imports-id-delete"
}
},
"/api/bulk/2.0/opportunities/contacts/imports/{id}/data":{
"post":{
"tags":[
"Bulk/2.0/opportunities"
],
"summary":"Upload data for an opportunity contact linkage import definition",
"description":"Uploads data for an opportunity contact linkage import definition. For more information about using these endpoints, see, using the opportunities endpoints.",
"operationId":"PostOpportunityContactLinkageImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The opportunity contact linkage import definition's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"OpportunityContactLinkageImportData",
"in":"body",
"description":"The request body contains details of the opportunity contact linkage import data.",
"required":true,
"schema":{
"title":"OpportunityContactLinkageImportData",
"type":"array",
"items":{
"title":"OpportunityContactLinkageImportDataItem",
"type":"object",
"items":{
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"OK.",
"schema":{
"title":"OpportunityContactLinkageImportDataResponse",
"description":"Sync response when POSTing opportunity contact linkage import data, and isSyncTriggeredOnImport = true on the import definition.",
"properties":{
"callbackUrl":{
"title":"callbackUrl",
"description":"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.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"status":{
"$ref":"#/definitions/SyncStatusType"
},
"syncedInstanceUri":{
"title":"syncedInstanceUri",
"description":"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.",
"type":"string"
},
"syncEndedAt":{
"format":"date-time",
"title":"syncEndedAt",
"description":"The date and time the sync ended. This is a read-only property.",
"type":"string"
},
"syncStartedAt":{
"format":"date-time",
"title":"syncStartedAt",
"description":"The date and time the sync started. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-opportunities-contacts-imports-{id}-data-post",
"x-filename-id":"api-bulk-2.0-opportunities-contacts-imports-id-data-post"
},
"delete":{
"tags":[
"Bulk/2.0/opportunities"
],
"summary":"Delete the synced data for an opportunity contact linkage import definition",
"description":"Deletes the synced data for an opportunity contact linkage import definition. For more information about using these endpoints, see, using the opportunities endpoints.",
"operationId":"DeleteOpportunityContactLinkageImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The opportunity contact linkage import definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-opportunities-contacts-imports-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-opportunities-contacts-imports-id-data-delete"
}
},
"/api/bulk/2.0/opportunities/fields/{id}":{
"get":{
"tags":[
"Bulk/2.0/opportunities"
],
"summary":"Retrieve an opportunity field definition",
"description":"Retrieves an opportunity field definition. For more information about using these endpoints, see, using the opportunities endpoints.",
"operationId":"GetOpportunityFieldIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The opportunity field definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"OpportunityFieldIndividualResponse",
"description":"The response body contains information about the opportunity field definition.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataType":{
"$ref":"#/definitions/DataType"
},
"defaultValue":{
"title":"defaultValue",
"description":"The opportunity field's default value.",
"type":"string"
},
"hasNotNullConstraint":{
"title":"hasNotNullConstraint",
"description":"Indicates whether the field can have null values (i.e. empty).",
"type":"boolean"
},
"hasReadOnlyConstraint":{
"title":"hasReadOnlyConstraint",
"description":"Indicates whether the field can be written to.",
"type":"boolean"
},
"hasUniquenessConstraint":{
"title":"hasUniquenessConstraint",
"description":"Indicates whether the field must have a unique value.",
"type":"boolean"
},
"internalName":{
"title":"internalName",
"description":"The field's internal name (used to uniquely identify it).",
"type":"string"
},
"name":{
"title":"name",
"description":"The opportunity field's name.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-opportunities-fields-{id}-get",
"x-filename-id":"api-bulk-2.0-opportunities-fields-id-get"
}
},
"/api/bulk/2.0/opportunities/fields":{
"get":{
"tags":[
"Bulk/2.0/opportunities"
],
"summary":"Retrieve a list of opportunity fields",
"description":"Retrieves a list of opportunity fields. For more information about using these endpoints, see, using the opportunities endpoints.",
"operationId":"GetOpportunityFieldSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"OpportunityFieldSearchResponse",
"description":"The response body contains information about the opportunity contact linkage import definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items returned.",
"type":"array",
"items":{
"$ref":"#/definitions/OpportunityField"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-opportunities-fields-get",
"x-filename-id":"api-bulk-2.0-opportunities-fields-get"
}
},
"/api/bulk/2.0/opportunities/imports":{
"get":{
"tags":[
"Bulk/2.0/opportunities"
],
"summary":"Retrieve a list of opportunity import definitions",
"description":"Retrieves a list of opportunity import definitions. For more information about using these endpoints, see, using the opportunities endpoints.",
"operationId":"GetOpportunityImportSearch",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"limit",
"in":"query",
"description":"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: ?limit=5.",
"type":"integer"
},
{
"name":"links",
"in":"query",
"description":"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.",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"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: ?offset=1000.",
"type":"integer"
},
{
"name":"orderBy",
"in":"query",
"description":"Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use \"*\" for wildcard values. Example: ?q=\"name=*Test*\" will find all the entities where the \"name\" field contains the string \"Test\".",
"type":"string"
},
{
"name":"totalResults",
"in":"query",
"description":"Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.",
"type":"boolean"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"OpportunityImportSearchResponse",
"description":"The response body contains information about the opportunity import definitions.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"hasMore":{
"title":"hasMore",
"description":"Indicates if there are more results.",
"type":"boolean"
},
"items":{
"title":"items",
"description":"The collection of items returned.",
"type":"array",
"items":{
"$ref":"#/definitions/Import"
}
},
"limit":{
"title":"limit",
"description":"The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.",
"type":"integer"
},
"offset":{
"title":"offset",
"description":"The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.",
"type":"integer"
},
"totalResults":{
"format":"int64",
"title":"totalResults",
"description":"Number of total results. Returned when the totalResults URL parameter is not set to false.",
"type":"integer"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-opportunities-imports-get",
"x-filename-id":"api-bulk-2.0-opportunities-imports-get"
},
"post":{
"tags":[
"Bulk/2.0/opportunities"
],
"summary":"Create an opportunity import definition",
"description":"Creates an opportunity import definition. For more information about using these endpoints, see, using the opportunities endpoints.",
"operationId":"PostOpportunityImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"OpportunityImportIndividual",
"in":"body",
"description":"The request body contains details of the opportunity import definition.",
"required":true,
"schema":{
"title":"OpportunityImportIndividual",
"description":"The request body defines the details of the opportunity import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isIdentifierFieldCaseSensitive":{
"title":"isIdentifierFieldCaseSensitive",
"description":"Whether or not to perform a case sensitive search on the identifier field.",
"type":"boolean"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not multiple matched records are being updated.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"OK.",
"schema":{
"title":"OpportunityImportIndividualResponse",
"description":"The response body includes information about the opportunity import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isIdentifierFieldCaseSensitive":{
"title":"isIdentifierFieldCaseSensitive",
"description":"Whether or not to perform a case sensitive search on the identifier field.",
"type":"boolean"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not multiple matched records are being updated.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-opportunities-imports-post",
"x-filename-id":"api-bulk-2.0-opportunities-imports-post"
}
},
"/api/bulk/2.0/opportunities/imports/{id}":{
"get":{
"tags":[
"Bulk/2.0/opportunities"
],
"summary":"Retrieve an opportunity import definition",
"description":"Retrieves a single opportunity import definition. For more information about using these endpoints, see, using the opportunities endpoints.",
"operationId":"GetOpportunityImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The opportunity import definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"OpportunityImportIndividualResponse",
"description":"The response body includes information about the opportunity import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isIdentifierFieldCaseSensitive":{
"title":"isIdentifierFieldCaseSensitive",
"description":"Whether or not to perform a case sensitive search on the identifier field.",
"type":"boolean"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not multiple matched records are being updated.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-opportunities-imports-{id}-get",
"x-filename-id":"api-bulk-2.0-opportunities-imports-id-get"
},
"put":{
"tags":[
"Bulk/2.0/opportunities"
],
"summary":"Update an opportunity import definition",
"description":"Updates an opportunity import definition. For more information about using these endpoints, see, using the opportunities endpoints.",
"operationId":"PutOpportunityImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The opportunity import definition's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"OpportunityImportIndividual",
"in":"body",
"description":"The request body contains details of the opportunity import definition.",
"required":true,
"schema":{
"title":"OpportunityImportIndividual",
"description":"The request body defines the details of the opportunity import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isIdentifierFieldCaseSensitive":{
"title":"isIdentifierFieldCaseSensitive",
"description":"Whether or not to perform a case sensitive search on the identifier field.",
"type":"boolean"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not multiple matched records are being updated.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
}
],
"responses":{
"200":{
"description":"OK.",
"schema":{
"title":"OpportunityImportIndividualResponse",
"description":"The response body includes information about the opportunity import definition.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isIdentifierFieldCaseSensitive":{
"title":"isIdentifierFieldCaseSensitive",
"description":"Whether or not to perform a case sensitive search on the identifier field.",
"type":"boolean"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not multiple matched records are being updated.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-opportunities-imports-{id}-put",
"x-filename-id":"api-bulk-2.0-opportunities-imports-id-put"
},
"delete":{
"tags":[
"Bulk/2.0/opportunities"
],
"summary":"Delete an opportunity import definition",
"description":"Deletes an opportunity import definition. For more information about using these endpoints, see, using the opportunities endpoints.",
"operationId":"DeleteOpportunityImportIndividual",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The opportunity import definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-opportunities-imports-{id}-delete",
"x-filename-id":"api-bulk-2.0-opportunities-imports-id-delete"
}
},
"/api/bulk/2.0/opportunities/imports/{id}/data":{
"post":{
"tags":[
"Bulk/2.0/opportunities"
],
"summary":"Upload data for an opportunity import definition",
"description":"Uploads data for an opportunity import definition. For more information about using these endpoints, see, using the opportunities endpoints. When uploading data, Eloqua expects that data to be encoded with UTF-8.",
"operationId":"PostOpportunityImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The opportunity import definition's resource identification number.",
"required":true,
"type":"integer"
},
{
"name":"OpportunityImportData",
"in":"body",
"description":"The request body contains details of the opportunity data.",
"required":true,
"schema":{
"title":"OpportunityImportData",
"type":"array",
"items":{
"title":"OpportunityImportDataItem",
"type":"object",
"items":{
"type":"string"
}
}
}
}
],
"responses":{
"201":{
"description":"OK.",
"schema":{
"title":"OpportunityImportDataResponse",
"description":"Sync response when POSTing opportunity import data, and isSyncTriggeredOnImport = true on the import definition.",
"properties":{
"callbackUrl":{
"title":"callbackUrl",
"description":"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.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"status":{
"$ref":"#/definitions/SyncStatusType"
},
"syncedInstanceUri":{
"title":"syncedInstanceUri",
"description":"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.",
"type":"string"
},
"syncEndedAt":{
"format":"date-time",
"title":"syncEndedAt",
"description":"The date and time the sync ended. This is a read-only property.",
"type":"string"
},
"syncStartedAt":{
"format":"date-time",
"title":"syncStartedAt",
"description":"The date and time the sync started. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-opportunities-imports-{id}-data-post",
"x-filename-id":"api-bulk-2.0-opportunities-imports-id-data-post"
},
"delete":{
"tags":[
"Bulk/2.0/opportunities"
],
"summary":"Delete the synced data for an opportunity import definition",
"description":"Deletes the synced data for an opportunity import definition. For more information about using these endpoints, see, using the opportunities endpoints.",
"operationId":"DeleteOpportunityImportData",
"consumes":[
"application/json",
"text/csv"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"id",
"in":"path",
"description":"The opportunity import definition's resource identification number.",
"required":true,
"type":"integer"
}
],
"responses":{
"204":{
"description":"No Content."
},
"400":{
"description":"Bad request. See Status Codes for information about other possible HTTP status codes."
},
"401":{
"description":"Unauthorized. See Status Codes for information about other possible HTTP status codes."
},
"403":{
"description":"Forbidden. See Status Codes for information about other possible HTTP status codes."
},
"404":{
"description":"The requested resource was not found. See Status Codes for information about other possible HTTP status codes."
},
"409":{
"description":"There was a conflict. See Status Codes for information about other possible HTTP status codes."
},
"410":{
"description":"The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes."
},
"412":{
"description":"The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes."
},
"413":{
"description":"Storage space exceeded. See Status Codes for information about other possible HTTP status codes."
},
"500":{
"description":"The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes."
},
"503":{
"description":"There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes."
}
},
"deprecated":false,
"x-internal-id":"api-bulk-2.0-opportunities-imports-{id}-data-delete",
"x-filename-id":"api-bulk-2.0-opportunities-imports-id-data-delete"
}
}
},
"definitions":{
"FolderRest20":{
"title":"Folder",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the folder. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The asset's current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"The name of the folder."
},
"description":{
"type":"string",
"description":"The description of the folder."
},
"permissions":{
"type":"array",
"description":"The permissions for the folder granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the folder."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the source template."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the folder."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the folder."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the folder was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the folder."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the folder."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the folder was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date and time the folder is scheduled for."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"isSystem":{
"type":"string",
"readOnly":true,
"description":"Whether or not the folder is a system folder."
},
"archive":{
"type":"string",
"description":"Whether or not the folder is archived."
}
}
},
"QueryResultFolderRest20":{
"title":"QueryResultFolder",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of folders.",
"items":{
"$ref":"#/definitions/FolderRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"QueryResultContractObjectRest20":{
"title":"QueryResultContractObject",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of generic objects.",
"items":{
"$ref":"#/definitions/MinimalRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"MinimalRest20":{
"title":"Minimal",
"properties":{
"type":{
"type":"string"
},
"id":{
"type":"string",
"readOnly":true
},
"currentStatus":{
"type":"string"
},
"description":{
"type":"string"
},
"permissions":{
"type":"array",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true
},
"sourceTemplateId":{
"type":"string"
},
"createdBy":{
"type":"string",
"readOnly":true
},
"createdByName":{
"type":"string"
},
"createdAt":{
"type":"string",
"readOnly":true
},
"updatedBy":{
"type":"string",
"readOnly":true
},
"updatedByName":{
"type":"string"
},
"updatedAt":{
"type":"string",
"readOnly":true
},
"scheduledFor":{
"type":"string",
"readOnly":true
},
"depth":{
"type":"string",
"readOnly":true
},
"name":{
"type":"string"
}
}
},
"FormRest10":{
"title":"Form",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the form. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The form's current status. Example: draft, active, or complete."
},
"name":{
"type":"string",
"description":"The name of the form."
},
"description":{
"type":"string",
"description":"The description of the form."
},
"permissions":{
"type":"string",
"description":"The permissions for the form granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the form."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the form was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the form."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the form was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"htmlName":{
"type":"string",
"description":"The asset's raw HTML name."
},
"processingType":{
"type":"string",
"description":"A list of the form's processing types. For example: externalEmail, externalWebsite, internallyHosted, internalAgentProxyForm."
},
"emailAddressFormFieldId":{
"type":"string",
"description":"The email address form field entity's unique identifier."
},
"submitFailedLandingPageId":{
"type":"string",
"description":"The landing page id of the failed submit."
},
"html":{
"type":"string",
"description":"The asset's raw HTML content."
},
"style":{
"type":"string",
"description":"The asset's main layout style."
},
"elements":{
"type":"array",
"description":"Array consisting of form elements.",
"items":{
"$ref":"#/definitions/FormElementRest10"
}
},
"processingSteps":{
"type":"array",
"description":"A list of the form's processing steps. There is no limit to the number of processing steps that can be included. Possible values include: FormStepAddToCampaign, FormStepAddToContactList, FormStepAddToDataCanvas, FormStepAddToProgram, FormStepAssociateToCampaign, FormStepCancelRegistration, FormStepUpdateContactEmailAddress, FormStepCreateUpdateEventRegistration, FormStepCreateUpdate, FormStepCreateUpdateFromFormField, FormStepGlobalSubscribe, FormStepGlobalUnsubscribe, FormStepGroupSubscription, FormStepPostData, FormStepRedirectToWebPage, FormStepRemoveFromContactList, FormStepRunIntegrationRules, FormStepSendEmail, FormStepSendNotificationEmail, FormStepWebTracking, FormStepGlobalSubscribe, and FormStepSmsPhoneNumberOptInOptOut.",
"items":{
"$ref":"#/definitions/FormProcessingStepRest10"
}
},
"isHidden":{
"type":"string",
"description":"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."
},
"archived":{
"type":"string",
"description":"True if form is archived otherwise False. This is a read-only property."
}
}
},
"QueryResultFormRest10":{
"title":"QueryResultForm",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of form fields.",
"items":{
"$ref":"#/definitions/FormRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"FormElementRest10":{
"title":"FormElement",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the form element. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The form element's current status."
},
"name":{
"type":"string",
"description":"Name of the form element."
},
"description":{
"type":"string",
"description":"The description of the form element."
},
"permissions":{
"type":"string",
"description":"The permissions for the form element granted to your current instance."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the form element."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the form element was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the form element."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the form element was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"instructions":{
"type":"string",
"description":"The form element's field instructions. Field instructions are optional instructions that help users fill in fields."
},
"style":{
"type":"string",
"description":"The asset's main layout style."
}
}
},
"FormProcessingStepRest10":{
"title":"FormProcessingStep",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the form processing step. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The form processing step's current status."
},
"name":{
"type":"string",
"description":"Name of the form processing step."
},
"description":{
"type":"string",
"description":"The description of the form processing step."
},
"permissions":{
"type":"string",
"description":"The permissions for the form processing step granted to your current instance."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the form processing step."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the form processing step was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the form processing step."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the form processing step was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"execute":{
"type":"string",
"description":"The conditions for which this form processing step will execute. Possible values include: always, conditionally, and never."
},
"conditionalType":{
"type":"string",
"description":"The type of value the comparator is validating. Possible values include: 'form field' or 'static value'."
},
"conditionalFieldId":{
"type":"string",
"description":"The form field id used to compare form fields within a form processing step condition."
},
"conditionalComparator":{
"type":"string",
"description":"The comparator used to validate a condition. Possible values include: exactly or not exactly."
},
"isConditionallyNegated":{
"type":"string",
"description":"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."
}
}
},
"QueryResultSenderCodeRest20":{
"title":"QueryResultSenderCode",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of sender code fields.",
"items":{
"$ref":"#/definitions/SenderCodeRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"SenderCodeRest20":{
"title":"SenderCode",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the sender code. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The sender code's current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"The name of the sender code."
},
"description":{
"type":"string",
"description":"The description of sender code."
},
"permissions":{
"type":"array",
"description":"The permissions for the sender code granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the sender code."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the sender code."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the sender code."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the sender code."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the sender code was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the sender code."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the sender code."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the sender code was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"senderCode":{
"type":"string",
"description":"Sender code."
},
"senderName":{
"type":"string",
"description":"Sender name."
},
"codeType":{
"type":"string",
"description":"Sender code type."
},
"routeType":{
"type":"string",
"description":"Sender code route type."
},
"aggregatorName":{
"type":"string",
"description":"Sender code Aggregator name."
},
"keywords":{
"type":"array",
"description":"Keywords associated with the sender code.",
"items":{
"$ref":"#/definitions/KeywordRest20"
}
},
"countries":{
"type":"array",
"description":"Countries associated with the sender code.",
"items":{
"$ref":"#/definitions/SenderCodeCountryRest20"
}
}
}
},
"KeywordRest20":{
"title":"Keyword",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the keyword. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The keyword's current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"The name of the keyword."
},
"description":{
"type":"string",
"description":"The description of the keyword."
},
"permissions":{
"type":"array",
"description":"The permissions for the keyword granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the keyword."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the keyword."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the keyword."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the keyword."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the keyword was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the keyword."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the keyword."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the keyword was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"keyword":{
"type":"string",
"description":"The name of the Keyword."
},
"keywordType":{
"type":"string",
"description":"The type of the keyword."
},
"keywordPosition":{
"type":"string",
"description":"Position of keyword."
},
"senderCodeId":{
"type":"integer",
"description":"Id of the associated sender code."
},
"countryCodes":{
"type":"array",
"description":"Countty codes associated with keyword.",
"items":{
"type":"string"
}
}
}
},
"SenderCodeCountryRest20":{
"title":"SenderCodeCountry",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the sender code country. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The sender code country current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"Name of the sender code country."
},
"description":{
"type":"string",
"description":"Description of the sender code country."
},
"permissions":{
"type":"array",
"description":"The permissions for the sender code country granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the sender code country."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the asset."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the sender code country."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the sender code country."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the sender code country was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the sender code country."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the sender code country."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the sender code country."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used"
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. For more information, see Request depth."
},
"code":{
"type":"string",
"description":"Sender code in the sender code country"
}
}
},
"LandingPageRest10":{
"title":"LandingPage",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the landing page. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The landing page's current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"The name of the landing page."
},
"description":{
"type":"string",
"description":"The description of the landing page."
},
"permissions":{
"type":"string",
"description":"The permissions for the landing page granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the landing page."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the landing page was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the landing page."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the landing page was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"deployedAt":{
"type":"string",
"description":"Unix timestamp for the date and time the landing page was deployed. This is a read-only property."
},
"micrositeId":{
"type":"string",
"description":"Id of the associated microsite."
},
"refreshedAt":{
"type":"string",
"description":"Unix timestamp for the date and time the landing page was last refreshed. This is a read-only property."
},
"htmlContent":{
"$ref":"#/definitions/HtmlContentRest10",
"description":"The landing page's raw html content."
},
"layout":{
"type":"string",
"description":"The landing page's main layout."
},
"style":{
"type":"string",
"description":"The landing page's main layout style."
},
"forms":{
"type":"array",
"description":"A list of forms contained within the landing page.",
"items":{
"$ref":"#/definitions/FormRest10"
}
},
"images":{
"type":"array",
"description":"A list of images contained within the landing page.",
"items":{
"$ref":"#/definitions/ImageFileRest10"
}
},
"hyperlinks":{
"type":"array",
"description":"A list of hyperlinks contained within the landing page.",
"items":{
"$ref":"#/definitions/HyperlinkRest10"
}
},
"contentSections":{
"type":"array",
"description":"A list of content sections contained within the landing page.",
"items":{
"$ref":"#/definitions/ContentSectionRest10"
}
},
"dynamicContents":{
"type":"array",
"description":"A list of dynamic contents contained within the landing page.",
"items":{
"$ref":"#/definitions/DynamicContentRest10"
}
},
"files":{
"type":"array",
"description":"A list of files contained within the landing page.",
"items":{
"$ref":"#/definitions/ImportedFileRest10"
}
},
"autoRedirectUrl":{
"type":"string",
"description":"The landing page's auto re-direct URL."
},
"autoRedirectWaitFor":{
"type":"string",
"description":"The amount of time the service will wait before redirecting to the auto re-direct URL."
},
"autoCloseWaitFor":{
"type":"string",
"description":"The amount of time the service will wait before closing."
},
"relativePath":{
"type":"string",
"description":"The relative path of the landing page."
}
}
},
"QueryResultLandingPageRest10":{
"title":"QueryResultLandingPage",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of landing page fields.",
"items":{
"$ref":"#/definitions/LandingPageRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"HtmlContentRest10":{
"title":"HtmlContent",
"properties":{
"type":{
"type":"string"
}
}
},
"ImageFileRest10":{
"title":"ImageFile",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the image. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The image's current status."
},
"name":{
"type":"string",
"description":"The name of the image."
},
"description":{
"type":"string",
"description":"The description of the image."
},
"permissions":{
"type":"string",
"description":"The permissions for the image granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the image."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the image was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the image."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the image was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"fullImageUrl":{
"type":"string",
"description":"The image's complete URL. This is a read-only property."
},
"size":{
"$ref":"#/definitions/SizeRest10",
"description":"The size of the image. Contains 3 fields: type, width and height. \"type\" should be set to \"Size\", and width and height can be set to the image's desired dimensions."
},
"thumbnailUrl":{
"type":"string",
"description":"The image's thumbnail URL. This is a read-only property."
}
}
},
"HyperlinkRest10":{
"title":"Hyperlink",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the hyperlink. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The hyperlink's current status."
},
"name":{
"type":"string",
"description":"Name of the hyperlink."
},
"description":{
"type":"string",
"description":"The description of the hyperlink."
},
"permissions":{
"type":"string",
"description":"The permissions for the hyperlink granted to your current instance."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the hyperlink."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the hyperlink was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the hyperlink."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the hyperlink was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"href":{
"type":"string",
"description":"Href value of the hyperlink."
},
"hyperlinkType":{
"type":"string",
"description":"The type of hyperlink. Possible values include: ExternalURL, ICSCalendarURL, LandingPageURL, ReferrerURL, RSSURL, or TrackedExternalURL."
},
"referencedEntityId":{
"type":"string",
"description":"Id of the referenced entity."
}
}
},
"ContentSectionRest10":{
"title":"ContentSection",
"properties":{
"type":{
"type":"string",
"description":"The content section's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the content section. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The content section's current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"The name of the content section."
},
"description":{
"type":"string",
"description":"The description of the content section."
},
"permissions":{
"type":"string",
"description":"The permissions for the content section granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the content section."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the content section was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the content section."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the content section was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"contentHtml":{
"type":"string",
"description":"The content section's HTML content."
},
"contentText":{
"type":"string",
"description":"The content section's text content."
},
"scope":{
"type":"string",
"description":"The content sections's scope: either local or global."
},
"forms":{
"type":"array",
"description":"A list of associated Form assets.",
"items":{
"$ref":"#/definitions/FormRest10"
}
},
"images":{
"type":"array",
"description":"A list of associated Image assets.",
"items":{
"$ref":"#/definitions/ImageFileRest10"
}
},
"hyperlinks":{
"type":"array",
"description":"A list of hyperlinks contained within the content section.",
"items":{
"$ref":"#/definitions/HyperlinkRest10"
}
},
"size":{
"$ref":"#/definitions/SizeRest10",
"description":"Generally contains 3 fields: type, width and height. \"type\" should be set to \"Size\", and width and height can be set to the content section's desired dimensions."
}
}
},
"DynamicContentRest10":{
"title":"DynamicContent",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the dynamic content. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The dynamic content's current status."
},
"name":{
"type":"string",
"description":"Name of the dynamic content."
},
"description":{
"type":"string",
"description":"The description of the dynamic content."
},
"permissions":{
"type":"string",
"description":"The permissions for the dynamic content granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the dynamic content."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the dynamic content was last accessed, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the dynamic content. This is a read-only property."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the dynamic content was last updated. This is a read-only property."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"defaultContentSection":{
"$ref":"#/definitions/ContentSectionRest10",
"description":"The default content section of the dynamic content."
},
"rules":{
"type":"array",
"description":"The dynamic content's rules.",
"items":{
"$ref":"#/definitions/DynamicContentRuleRest10"
}
}
}
},
"ImportedFileRest10":{
"title":"ImportedFile",
"properties":{
"type":{
"type":"string",
"description":"The date and time the imported file was last accessed. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the imported file. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The imported file's current status."
},
"name":{
"type":"string",
"description":"Name of the imported file."
},
"description":{
"type":"string",
"description":"The description of the imported file."
},
"permissions":{
"type":"string",
"description":"The permissions for the imported file granted to your current instance."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the imported file."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the imported file was last accessed, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the imported file. This is a read-only property."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the imported file was last updated. This is a read-only property."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"fileName":{
"type":"string",
"description":"The file name of the imported file."
},
"link":{
"type":"string",
"description":"The imported file's complete URL. This is a read-only property."
},
"trackedLink":{
"type":"string",
"description":"The imported file's tracked complete URL. This is a read-only property."
},
"brandId":{
"type":"string",
"description":"ImportedFile_Field_BrandId_Description"
}
}
},
"SizeRest10":{
"title":"Size",
"properties":{
"type":{
"type":"string"
}
}
},
"DynamicContentRuleRest10":{
"title":"DynamicContentRule",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The Dynamic Content Rule 's current status."
},
"id":{
"type":"string",
"description":"Id of the dynamic content rule. This is a read-only property."
},
"depth":{
"type":"string",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"contentSection":{
"$ref":"#/definitions/ContentSectionRest10",
"description":"A list of associated Content Section assets."
},
"criteria":{
"type":"array",
"description":"The criteria of the dynamic content rule.",
"items":{
"$ref":"#/definitions/CriterionRest10"
}
},
"statement":{
"type":"string",
"description":"The statement of the dynamic content rule."
}
}
},
"CriterionRest10":{
"title":"Criterion",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the criterion. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The criterion's current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"Name of the criterion."
},
"description":{
"type":"string",
"description":"The description of the criterion."
},
"permissions":{
"type":"string",
"description":"The permissions for the criterion granted to your current instance."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the criterion."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the criterion was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the criterion."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the criterion was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
}
}
},
"MicrositeRest10":{
"title":"Microsite",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the microsite. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The campaign's current status."
},
"name":{
"type":"string",
"description":"The name of the microsite."
},
"description":{
"type":"string",
"description":"The description of the microsite."
},
"permissions":{
"type":"string",
"description":"The permissions for the microsite granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the microsite."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the microsite was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the microsite."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the microsite was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"domains":{
"type":"array",
"description":"A collection of associated sub domains.",
"items":{
"type":"string"
}
},
"defaultLandingPageId":{
"type":"string",
"description":"The id for the associated default landing page."
},
"isAllowedInFrame":{
"type":"string",
"description":"Whether pages associated to the microsite can be embedded within frames, iframes, or objects. Learn more."
}
}
},
"QueryResultMicrositeRest10":{
"title":"QueryResultMicrosite",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of microsite fields.",
"items":{
"$ref":"#/definitions/MicrositeRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"QueryResultInvalidResponseMessageRest20":{
"title":"QueryResultInvalidResponseMessage",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of invalid response message fields.",
"items":{
"$ref":"#/definitions/InvalidResponseMessageRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"InvalidResponseMessageRest20":{
"title":"InvalidResponseMessage",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the invalid response message. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The invalid response message's current status. This is a read-only property."
},
"description":{
"type":"string",
"description":"The description of the invalid response message."
},
"permissions":{
"type":"array",
"description":"The permissions for the invalid response message granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the invalid response message."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the invalid response message."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the invalid response message."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the invalid response message."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the invalid response message was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the invalid response message."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the invalid response message."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the invalid response code was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"response":{
"type":"string",
"description":"The invalid response message"
},
"templateId":{
"type":"string",
"description":"This property is not used."
},
"senderCodeId":{
"type":"integer",
"description":"Id of the associated sender code."
},
"countryCodes":{
"type":"array",
"description":"Country codes associated with invalid response message.",
"items":{
"type":"string"
}
}
}
},
"ProgramRest20":{
"title":"Program",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the program."
},
"currentStatus":{
"type":"string",
"description":"The program's current status: Active, Draft, Scheduled, Paused, or Completed."
},
"name":{
"type":"string",
"description":"The name of the program."
},
"description":{
"type":"string",
"description":"The description of the program."
},
"permissions":{
"type":"array",
"description":"The permissions for the program granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the program."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the asset."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the program."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the program."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the program was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the program."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the program."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the program was last updated. This is a read-only property."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the program is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"elements":{
"type":"array",
"description":"A list of program elements.",
"items":{
"$ref":"#/definitions/CampaignElementRest20"
}
},
"isReadOnly":{
"type":"string",
"description":"Whether or not the program is read only."
},
"runAsUserId":{
"type":"string",
"description":"The login id of the user to activate the program."
},
"isExitHistoryDisabled":{
"type":"string",
"description":"Whether or not the Exit History is disabled due to high volume. This is a read-only property."
},
"isBypassHistoryDisabled":{
"type":"string",
"description":"Whether or not the Bypass History is disabled due to high volume. This is a read-only property."
},
"isMemberAllowedDuplicates":{
"type":"string",
"description":"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":{
"type":"string",
"description":"The program type, possible values are Contact or CustomObjectRecords."
},
"defaultEntityId":{
"type":"string",
"description":"The id of the custom object data set. Only used for custom object programs."
}
}
},
"QueryResultProgramRest20":{
"title":"QueryResultProgram",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of program fields.",
"items":{
"$ref":"#/definitions/ProgramRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"CampaignElementRest20":{
"title":"CampaignElement",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the campaign element. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The campaign element's current status."
},
"name":{
"type":"string",
"description":"Name of the campaign element. This is a read-only property."
},
"description":{
"type":"string",
"description":"The description of the campaign element."
},
"permissions":{
"type":"array",
"description":"The permissions for the campaign element granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"Id of the associated folder."
},
"sourceTemplateId":{
"type":"string",
"description":"The id of the source template."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the campaign element."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the campaign element."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the campaign element was created, expressed in Unix time. "
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the campaign element."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the campaign element."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the campaign element was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the campaign element is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"position":{
"$ref":"#/definitions/PositionRest20",
"description":"Array of campaign element position fields."
},
"outputTerminals":{
"type":"array",
"description":"A list of the campaign element ids within the campaign. This is a read-only property.",
"items":{
"$ref":"#/definitions/CampaignOutputTerminalRest20"
}
},
"memberCount":{
"type":"string",
"description":"Amount of members within the campaign element. This is a read-only property."
},
"memberErrorCount":{
"type":"string",
"description":"Amount of members within the campaign element in errored status. This is a read-only property."
}
}
},
"PositionRest20":{
"title":"Position",
"properties":{
"type":{
"type":"string",
"description":"The campaign element's type. This is a read-only property."
},
"x":{
"type":"string",
"description":"The position of the campaign element on the x axis."
},
"y":{
"type":"string",
"description":"The position of the campaign element on the y axis."
}
}
},
"CampaignOutputTerminalRest20":{
"title":"CampaignOutputTerminal",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the campaign output terminal. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The campaign output terminal's current status."
},
"name":{
"type":"string",
"description":"Name of the campaign output terminal."
},
"description":{
"type":"string",
"description":"The description of the campaign output terminal."
},
"permissions":{
"type":"array",
"description":"The permissions for the campaign output terminal granted to your current instance.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"Id of the associated folder."
},
"sourceTemplateId":{
"type":"string",
"description":"The id of the source template."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the campaign output terminal."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the campaign output terminal."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the campaign output terminal was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the campaign output terminal."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the campaign output terminal."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the campaign output terminal was last updated. This is a read-only property."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the campaign output terminal is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. For more information, see Request depth."
},
"terminalType":{
"type":"string",
"description":"The campaign output terminal type. This is a read-only property."
},
"connectedType":{
"type":"string",
"description":"The campaign output terminal's connection type. This is a read-only property."
},
"connectedId":{
"type":"string",
"description":"The connected id of the campaign output terminal. This is a read-only property."
}
}
},
"LookupTableRest20":{
"title":"LookupTable",
"properties":{
"type":{
"type":"string",
"description":"The lookup table type"
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the lookup table. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The status of the lookup table."
},
"name":{
"type":"string",
"description":"The name of the lookup table."
},
"description":{
"type":"string",
"description":"The description of the lookup table."
},
"permissions":{
"type":"array",
"description":"The permissions for the lookup table granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the lookup table."
},
"sourceTemplateId":{
"type":"string",
"description":"The Id for the source template of the lookup table."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the lookup table."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the lookup table."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the lookup table was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who last updated the lookup table."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the lookup table."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the lookup table was last updated, expressed in Unix time."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the lookup table is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"lookupFieldName":{
"type":"string",
"description":"The lookup field of the lookup table."
},
"replacementFieldName":{
"type":"string",
"description":"The replacement field of the lookup table."
},
"valuesAreCaseSensitive":{
"type":"string",
"description":"While compare lookup field with case sensitive rule or not."
}
}
},
"QueryResultLookupTableRest20":{
"title":"QueryResultLookupTable",
"properties":{
"type":{
"type":"string",
"description":"The lookup table field's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of the lookup table fields.",
"items":{
"$ref":"#/definitions/LookupTableRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"QueryResultLookupTableEntryRest20":{
"title":"QueryResultLookupTableEntry",
"properties":{
"type":{
"type":"string",
"description":"The lookup table entry field's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of the lookup table element fields.",
"items":{
"$ref":"#/definitions/LookupTableEntryRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"LookupTableEntryRest20":{
"title":"LookupTableEntry",
"properties":{
"type":{
"type":"string",
"description":"The lookup table entry type."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the lookup table entry. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The status of the lookup table entry."
},
"key":{
"type":"string",
"description":"The Key of each lookup table entry."
},
"value":{
"type":"string",
"description":"The Value of each lookup table entry."
}
}
},
"QueryResultImageRest10":{
"title":"QueryResultImage",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of image fields.",
"items":{
"$ref":"#/definitions/ImageFileRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"AuditLogReportRequestRest20":{
"title":"AuditLogReportRequest",
"properties":{
"type":{
"type":"string",
"description":"This property is not used."
},
"auditReportType":{
"type":"string",
"description":"Specifies the Audit Report Type to generate. Possible values include: assets (asset history), securityGroup (security group history), userProfile (user profile history), userLogin (user login history), dataExport (export history), and dataUpload (upload history)."
},
"startDate":{
"type":"string",
"description":"The start date and time (10 digit integer Unix time). This property is required."
},
"endDate":{
"type":"string",
"description":"The end date and time (10 digit integer Unix time). This property is required."
},
"notificationEmail":{
"type":"string",
"description":"Email address for export notification. This property is required."
},
"fileFormat":{
"type":"string",
"description":"File format to be exported. Possible values include: delimitedFile or Excel2007."
},
"assetTypes":{
"type":"string",
"description":"The asset type for the Audit log. Required if auditReportType is set to assets. Possible values include: forms, programs, campaigns, emails, and landingPages. Specify multiple asset types by comma separating values."
},
"actionName":{
"type":"string",
"description":"The event action to filter for the audit log. Possible values include: all, create, modify, delete, archive and unarchive. For campaigns, possible values also include: activated, deactivated, pause, and scheduleForActivation. If not specified, defaults to all."
},
"status":{
"type":"string",
"description":"For dataUpload and dataExport audit reports, you can filter on the status. Possible values include: completed, in progress, queued, waiting, failed, and inactive."
},
"userName":{
"type":"string",
"description":"The user name to filter on."
},
"userId":{
"$ref":"#/definitions/System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]Rest20",
"description":"AuditLogReportRequest_Field_UserId_Description"
}
}
},
"System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]Rest20":{
"title":"System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]",
"properties":{
}
},
"SyncAction":{
"title":"SyncAction",
"description":"The definition of the action to take at time of syncronization.",
"properties":{
"action":{
"$ref":"#/definitions/SyncActionType"
},
"destination":{
"title":"destination",
"description":"The ML statement used to reference an object used by the action.",
"type":"string"
},
"status":{
"$ref":"#/definitions/MemberStatus"
},
"updateAll":{
"title":"updateAll",
"description":"Update status of all records in an execution.",
"type":"boolean"
}
}
},
"SyncActionType":{
"title":"SyncActionType",
"description":"The action to take at time of synchronization.",
"default":"add",
"enum":[
"add",
"remove",
"setStatus"
],
"type":"string"
},
"MemberStatus":{
"title":"MemberStatus",
"description":"The status of members.",
"default":"bounced",
"enum":[
"bounced",
"subscribed",
"unsubscribed",
"active",
"complete",
"pending",
"errored",
"yes",
"no",
"invalid",
"permission"
],
"type":"string"
},
"Export":{
"title":"Export",
"description":"The request body defines the details of the export definition. The following table displays properties for creating export definitions.",
"properties":{
"areSystemTimestampsInUTC":{
"title":"areSystemTimestampsInUTC",
"description":"Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.",
"type":"boolean"
},
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"crmAccountIdField":{
"title":"crmAccountIdField",
"description":"The ML statement for an existing contact field which addresses the CRM account ID.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The external system ID is used when exporting data containing CRM fields.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"filter":{
"title":"filter",
"description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.",
"type":"string"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"maxRecords":{
"title":"maxRecords",
"description":"The maximum amount of records.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the export definition.",
"type":"string"
},
"productIdField":{
"title":"productIdField",
"description":"The ML statement for an existing campaign field which addresses the product ID.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"DataType":{
"title":"DataType",
"description":"The type of data, used for field definitions.",
"default":"number",
"enum":[
"number",
"string",
"boolean",
"date",
"emailAddress"
],
"type":"string"
},
"CampaignResponseField":{
"title":"CampaignResponseField",
"description":"The definition of a campaign response field in the system.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the campaign response field was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the campaign response field. This is a read-only property.",
"type":"string"
},
"dataType":{
"$ref":"#/definitions/DataType"
},
"defaultValue":{
"title":"defaultValue",
"description":"The campaign response field's default value.",
"type":"string"
},
"hasNotNullConstraint":{
"title":"hasNotNullConstraint",
"description":"Indicates whether the campaign response field can have null values (i.e. empty).",
"type":"boolean"
},
"hasReadOnlyConstraint":{
"title":"hasReadOnlyConstraint",
"description":"Indicates whether the field can be written to.",
"type":"boolean"
},
"hasUniquenessConstraint":{
"title":"hasUniquenessConstraint",
"description":"Indicates whether the field must have a unique value.",
"type":"boolean"
},
"internalName":{
"title":"internalName",
"description":"The field's internal name (used to uniquely identify it).",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the campaign response field definition.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the campaign response field was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"ImportRuleType":{
"title":"ImportRuleType",
"description":"Import.ImportRuleType_Description",
"default":"createAndUpdate",
"enum":[
"createAndUpdate",
"updateOnly",
"createOnly"
],
"type":"string"
},
"RuleType":{
"title":"RuleType",
"description":"The rule used when doing updates on existing data. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"default":"always",
"enum":[
"always",
"ifNewIsNotNull",
"ifExistingIsNull",
"useFieldRule"
],
"type":"string"
},
"Import":{
"title":"Import",
"description":"The request body defines the details of the import definition. The following table displays properties for creating import definitions.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataRetentionDuration":{
"title":"dataRetentionDuration",
"description":"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.",
"type":"string"
},
"externalSystemId":{
"title":"externalSystemId",
"description":"The id of the external system.",
"type":"integer"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"importPriorityUri":{
"title":"importPriorityUri",
"description":"Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center.",
"type":"string"
},
"importRule":{
"$ref":"#/definitions/ImportRuleType"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered on import.",
"type":"boolean"
},
"isUpdatingMultipleMatchedRecords":{
"title":"isUpdatingMultipleMatchedRecords",
"description":"Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress).",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kilobytes. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the import definition.",
"type":"string"
},
"nullIdentifierFieldName":{
"title":"nullIdentifierFieldName",
"description":"Whether or not to null the identifier field.",
"type":"boolean"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.\r\n\r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"updateRule":{
"$ref":"#/definitions/RuleType"
},
"updateRuleByField":{
"title":"updateRuleByField",
"description":"The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type.",
"type":"object"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"SyncStatusType":{
"title":"SyncStatusType",
"description":"The status of the synchronization. This is a read-only property.",
"default":"pending",
"enum":[
"pending",
"active",
"success",
"warning",
"error"
],
"type":"string"
},
"ContactListRest10":{
"title":"ContactList",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the contact list."
},
"currentStatus":{
"type":"string",
"description":"The contact list's current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"The contact list's name."
},
"description":{
"type":"string",
"description":"The description of the contact list."
},
"permissions":{
"type":"string",
"description":"The permissions for the contact list granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the contact list. This is a read-only property."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the contact segment was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the contact list."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the contact list was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"scope":{
"type":"string",
"description":"The contact list's scope: either local or global."
},
"count":{
"type":"string",
"readOnly":true,
"description":"The number of contacts in the contact list. This is a read-only property."
},
"membershipAdditions":{
"type":"array",
"description":"The number of contact membership additions in the contact list.",
"items":{
"type":"string"
}
},
"membershipDeletions":{
"type":"array",
"description":"The number of contact membership deletions in the contact list.",
"items":{
"type":"string"
}
},
"dataLookupId":{
"type":"string",
"description":"The contact list's data lookup Id. This is a read-only property."
}
}
},
"QueryResultListRest10":{
"title":"QueryResultList",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of contact list fields.",
"items":{
"$ref":"#/definitions/ContactListRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"ODataQueryOptions[Calendar]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"ODataQueryContext":{
"type":"object",
"properties":{
"defaultQuerySettings":{
"$ref":"#/definitions/DefaultQuerySettings",
"readOnly":true
},
"model":{
"$ref":"#/definitions/IEdmModel",
"readOnly":true
},
"elementType":{
"$ref":"#/definitions/IEdmType",
"readOnly":true
},
"navigationSource":{
"$ref":"#/definitions/IEdmNavigationSource",
"readOnly":true
},
"elementClrType":{
"type":"string",
"readOnly":true
},
"path":{
"$ref":"#/definitions/ODataPath",
"readOnly":true
},
"requestContainer":{
"$ref":"#/definitions/IServiceProvider",
"readOnly":true
}
}
},
"ODataRawQueryOptions":{
"type":"object",
"properties":{
"filter":{
"type":"string",
"readOnly":true
},
"apply":{
"type":"string",
"readOnly":true
},
"orderBy":{
"type":"string",
"readOnly":true
},
"top":{
"type":"string",
"readOnly":true
},
"skip":{
"type":"string",
"readOnly":true
},
"select":{
"type":"string",
"readOnly":true
},
"expand":{
"type":"string",
"readOnly":true
},
"count":{
"type":"string",
"readOnly":true
},
"format":{
"type":"string",
"readOnly":true
},
"skipToken":{
"type":"string",
"readOnly":true
},
"deltaToken":{
"type":"string",
"readOnly":true
}
}
},
"SelectExpandQueryOption":{
"type":"object",
"properties":{
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawSelect":{
"type":"string",
"readOnly":true
},
"rawExpand":{
"type":"string",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/SelectExpandQueryValidator"
},
"selectExpandClause":{
"$ref":"#/definitions/SelectExpandClause",
"readOnly":true
},
"levelsMaxLiteralExpansionDepth":{
"format":"int32",
"type":"integer"
}
}
},
"ApplyQueryOption":{
"type":"object",
"properties":{
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"resultClrType":{
"type":"string",
"readOnly":true
},
"applyClause":{
"$ref":"#/definitions/ApplyClause",
"readOnly":true
},
"rawValue":{
"type":"string",
"readOnly":true
}
}
},
"FilterQueryOption":{
"type":"object",
"properties":{
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/FilterQueryValidator"
},
"filterClause":{
"$ref":"#/definitions/FilterClause",
"readOnly":true
},
"rawValue":{
"type":"string",
"readOnly":true
}
}
},
"OrderByQueryOption":{
"type":"object",
"properties":{
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"orderByNodes":{
"type":"array",
"items":{
"$ref":"#/definitions/OrderByNode"
},
"readOnly":true
},
"rawValue":{
"type":"string",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/OrderByQueryValidator"
},
"orderByClause":{
"$ref":"#/definitions/OrderByClause",
"readOnly":true
}
}
},
"SkipQueryOption":{
"type":"object",
"properties":{
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValue":{
"type":"string",
"readOnly":true
},
"value":{
"format":"int32",
"type":"integer",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/SkipQueryValidator"
}
}
},
"SkipTokenQueryOption":{
"type":"object",
"properties":{
"rawValue":{
"type":"string",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/SkipTokenQueryValidator",
"readOnly":true
},
"querySettings":{
"$ref":"#/definitions/ODataQuerySettings",
"readOnly":true
},
"queryOptions":{
"$ref":"#/definitions/ODataQueryOptions",
"readOnly":true
}
}
},
"TopQueryOption":{
"type":"object",
"properties":{
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValue":{
"type":"string",
"readOnly":true
},
"value":{
"format":"int32",
"type":"integer",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/TopQueryValidator"
}
}
},
"CountQueryOption":{
"type":"object",
"properties":{
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValue":{
"type":"string",
"readOnly":true
},
"value":{
"type":"boolean",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/CountQueryValidator"
}
}
},
"ODataQueryValidator":{
"type":"object",
"properties":{
}
},
"DefaultQuerySettings":{
"type":"object",
"properties":{
"enableExpand":{
"type":"boolean"
},
"enableSelect":{
"type":"boolean"
},
"enableCount":{
"type":"boolean"
},
"enableOrderBy":{
"type":"boolean"
},
"enableFilter":{
"type":"boolean"
},
"maxTop":{
"format":"int32",
"type":"integer"
},
"enableSkipToken":{
"type":"boolean"
}
}
},
"IEdmModel":{
"type":"object",
"properties":{
"schemaElements":{
"type":"array",
"items":{
"$ref":"#/definitions/IEdmSchemaElement"
},
"readOnly":true
},
"vocabularyAnnotations":{
"type":"array",
"items":{
"$ref":"#/definitions/IEdmVocabularyAnnotation"
},
"readOnly":true
},
"referencedModels":{
"type":"array",
"items":{
"$ref":"#/definitions/IEdmModel"
},
"readOnly":true
},
"declaredNamespaces":{
"type":"array",
"items":{
"type":"string"
},
"readOnly":true
},
"directValueAnnotationsManager":{
"$ref":"#/definitions/IEdmDirectValueAnnotationsManager",
"readOnly":true
},
"entityContainer":{
"$ref":"#/definitions/IEdmEntityContainer",
"readOnly":true
}
}
},
"IEdmType":{
"type":"object",
"properties":{
"typeKind":{
"format":"int32",
"enum":[
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"type":"integer",
"readOnly":true
}
}
},
"IEdmNavigationSource":{
"type":"object",
"properties":{
"navigationPropertyBindings":{
"type":"array",
"items":{
"$ref":"#/definitions/IEdmNavigationPropertyBinding"
},
"readOnly":true
},
"path":{
"$ref":"#/definitions/IEdmPathExpression",
"readOnly":true
},
"type":{
"$ref":"#/definitions/IEdmType",
"readOnly":true
},
"name":{
"type":"string",
"readOnly":true
}
}
},
"ODataPath":{
"type":"object",
"properties":{
"edmType":{
"$ref":"#/definitions/IEdmType",
"readOnly":true
},
"navigationSource":{
"$ref":"#/definitions/IEdmNavigationSource",
"readOnly":true
},
"segments":{
"type":"array",
"items":{
"$ref":"#/definitions/ODataPathSegment"
},
"readOnly":true
},
"pathTemplate":{
"type":"string",
"readOnly":true
},
"path":{
"type":"array",
"items":{
"$ref":"#/definitions/ODataPathSegment"
},
"readOnly":true
}
}
},
"IServiceProvider":{
"type":"object",
"properties":{
}
},
"SelectExpandQueryValidator":{
"type":"object",
"properties":{
}
},
"SelectExpandClause":{
"type":"object",
"properties":{
"selectedItems":{
"type":"array",
"items":{
"$ref":"#/definitions/SelectItem"
},
"readOnly":true
},
"allSelected":{
"type":"boolean",
"readOnly":true
}
}
},
"ApplyClause":{
"type":"object",
"properties":{
"transformations":{
"type":"array",
"items":{
"$ref":"#/definitions/TransformationNode"
},
"readOnly":true
}
}
},
"FilterQueryValidator":{
"type":"object",
"properties":{
}
},
"FilterClause":{
"type":"object",
"properties":{
"expression":{
"$ref":"#/definitions/SingleValueNode",
"readOnly":true
},
"rangeVariable":{
"$ref":"#/definitions/RangeVariable",
"readOnly":true
},
"itemType":{
"$ref":"#/definitions/IEdmTypeReference",
"readOnly":true
}
}
},
"OrderByNode":{
"type":"object",
"properties":{
"direction":{
"format":"int32",
"enum":[
0,
1
],
"type":"integer",
"readOnly":true
}
}
},
"OrderByQueryValidator":{
"type":"object",
"properties":{
}
},
"OrderByClause":{
"type":"object",
"properties":{
"thenBy":{
"$ref":"#/definitions/OrderByClause",
"readOnly":true
},
"expression":{
"$ref":"#/definitions/SingleValueNode",
"readOnly":true
},
"direction":{
"format":"int32",
"enum":[
0,
1
],
"type":"integer",
"readOnly":true
},
"rangeVariable":{
"$ref":"#/definitions/RangeVariable",
"readOnly":true
},
"itemType":{
"$ref":"#/definitions/IEdmTypeReference",
"readOnly":true
}
}
},
"SkipQueryValidator":{
"type":"object",
"properties":{
}
},
"SkipTokenQueryValidator":{
"type":"object",
"properties":{
}
},
"ODataQuerySettings":{
"type":"object",
"properties":{
"ensureStableOrdering":{
"type":"boolean"
},
"handleNullPropagation":{
"format":"int32",
"enum":[
0,
1,
2
],
"type":"integer"
},
"enableConstantParameterization":{
"type":"boolean"
},
"enableCorrelatedSubqueryBuffering":{
"type":"boolean"
},
"pageSize":{
"format":"int32",
"type":"integer"
},
"handleReferenceNavigationPropertyExpandFilter":{
"type":"boolean"
}
}
},
"ODataQueryOptions":{
"type":"object",
"properties":{
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
},
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
}
}
},
"TopQueryValidator":{
"type":"object",
"properties":{
}
},
"CountQueryValidator":{
"type":"object",
"properties":{
}
},
"IEdmSchemaElement":{
"type":"object",
"properties":{
"schemaElementKind":{
"format":"int32",
"enum":[
0,
1,
2,
3,
4,
5
],
"type":"integer",
"readOnly":true
},
"namespace":{
"type":"string",
"readOnly":true
},
"name":{
"type":"string",
"readOnly":true
}
}
},
"IEdmVocabularyAnnotation":{
"type":"object",
"properties":{
"qualifier":{
"type":"string",
"readOnly":true
},
"term":{
"$ref":"#/definitions/IEdmTerm",
"readOnly":true
},
"target":{
"$ref":"#/definitions/IEdmVocabularyAnnotatable",
"readOnly":true
},
"value":{
"$ref":"#/definitions/IEdmExpression",
"readOnly":true
}
}
},
"IEdmDirectValueAnnotationsManager":{
"type":"object",
"properties":{
}
},
"IEdmEntityContainer":{
"type":"object",
"properties":{
"elements":{
"type":"array",
"items":{
"$ref":"#/definitions/IEdmEntityContainerElement"
},
"readOnly":true
},
"schemaElementKind":{
"format":"int32",
"enum":[
0,
1,
2,
3,
4,
5
],
"type":"integer",
"readOnly":true
},
"namespace":{
"type":"string",
"readOnly":true
},
"name":{
"type":"string",
"readOnly":true
}
}
},
"IEdmNavigationPropertyBinding":{
"type":"object",
"properties":{
"navigationProperty":{
"$ref":"#/definitions/IEdmNavigationProperty",
"readOnly":true
},
"target":{
"$ref":"#/definitions/IEdmNavigationSource",
"readOnly":true
},
"path":{
"$ref":"#/definitions/IEdmPathExpression",
"readOnly":true
}
}
},
"IEdmPathExpression":{
"type":"object",
"properties":{
"pathSegments":{
"type":"array",
"items":{
"type":"string"
},
"readOnly":true
},
"path":{
"type":"string",
"readOnly":true
},
"expressionKind":{
"format":"int32",
"enum":[
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25
],
"type":"integer",
"readOnly":true
}
}
},
"ODataPathSegment":{
"type":"object",
"properties":{
"edmType":{
"$ref":"#/definitions/IEdmType",
"readOnly":true
},
"identifier":{
"type":"string"
}
}
},
"SelectItem":{
"type":"object",
"properties":{
}
},
"TransformationNode":{
"type":"object",
"properties":{
"kind":{
"format":"int32",
"enum":[
0,
1,
2,
3,
4
],
"type":"integer",
"readOnly":true
}
}
},
"SingleValueNode":{
"type":"object",
"properties":{
"typeReference":{
"$ref":"#/definitions/IEdmTypeReference",
"readOnly":true
},
"kind":{
"format":"int32",
"enum":[
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33
],
"type":"integer",
"readOnly":true
}
}
},
"RangeVariable":{
"type":"object",
"properties":{
"name":{
"type":"string",
"readOnly":true
},
"typeReference":{
"$ref":"#/definitions/IEdmTypeReference",
"readOnly":true
},
"kind":{
"format":"int32",
"type":"integer",
"readOnly":true
}
}
},
"IEdmTypeReference":{
"type":"object",
"properties":{
"isNullable":{
"type":"boolean",
"readOnly":true
},
"definition":{
"$ref":"#/definitions/IEdmType",
"readOnly":true
}
}
},
"IEdmTerm":{
"type":"object",
"properties":{
"type":{
"$ref":"#/definitions/IEdmTypeReference",
"readOnly":true
},
"appliesTo":{
"type":"string",
"readOnly":true
},
"defaultValue":{
"type":"string",
"readOnly":true
},
"schemaElementKind":{
"format":"int32",
"enum":[
0,
1,
2,
3,
4,
5
],
"type":"integer",
"readOnly":true
},
"namespace":{
"type":"string",
"readOnly":true
},
"name":{
"type":"string",
"readOnly":true
}
}
},
"IEdmVocabularyAnnotatable":{
"type":"object",
"properties":{
}
},
"IEdmExpression":{
"type":"object",
"properties":{
"expressionKind":{
"format":"int32",
"enum":[
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25
],
"type":"integer",
"readOnly":true
}
}
},
"IEdmEntityContainerElement":{
"type":"object",
"properties":{
"containerElementKind":{
"format":"int32",
"enum":[
0,
1,
2,
3,
4
],
"type":"integer",
"readOnly":true
},
"container":{
"$ref":"#/definitions/IEdmEntityContainer",
"readOnly":true
},
"name":{
"type":"string",
"readOnly":true
}
}
},
"IEdmNavigationProperty":{
"type":"object",
"properties":{
"partner":{
"$ref":"#/definitions/IEdmNavigationProperty",
"readOnly":true
},
"onDelete":{
"format":"int32",
"enum":[
0,
1
],
"type":"integer",
"readOnly":true
},
"containsTarget":{
"type":"boolean",
"readOnly":true
},
"referentialConstraint":{
"$ref":"#/definitions/IEdmReferentialConstraint",
"readOnly":true
},
"propertyKind":{
"format":"int32",
"enum":[
0,
1,
2
],
"type":"integer",
"readOnly":true
},
"type":{
"$ref":"#/definitions/IEdmTypeReference",
"readOnly":true
},
"declaringType":{
"$ref":"#/definitions/IEdmStructuredType",
"readOnly":true
},
"name":{
"type":"string",
"readOnly":true
}
}
},
"IEdmReferentialConstraint":{
"type":"object",
"properties":{
"propertyPairs":{
"type":"array",
"items":{
"$ref":"#/definitions/EdmReferentialConstraintPropertyPair"
},
"readOnly":true
}
}
},
"IEdmStructuredType":{
"type":"object",
"properties":{
"isAbstract":{
"type":"boolean",
"readOnly":true
},
"isOpen":{
"type":"boolean",
"readOnly":true
},
"baseType":{
"$ref":"#/definitions/IEdmStructuredType",
"readOnly":true
},
"declaredProperties":{
"type":"array",
"items":{
"$ref":"#/definitions/IEdmProperty"
},
"readOnly":true
},
"typeKind":{
"format":"int32",
"enum":[
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"type":"integer",
"readOnly":true
}
}
},
"EdmReferentialConstraintPropertyPair":{
"type":"object",
"properties":{
"dependentProperty":{
"$ref":"#/definitions/IEdmStructuralProperty",
"readOnly":true
},
"principalProperty":{
"$ref":"#/definitions/IEdmStructuralProperty",
"readOnly":true
}
}
},
"IEdmProperty":{
"type":"object",
"properties":{
"propertyKind":{
"format":"int32",
"enum":[
0,
1,
2
],
"type":"integer",
"readOnly":true
},
"type":{
"$ref":"#/definitions/IEdmTypeReference",
"readOnly":true
},
"declaringType":{
"$ref":"#/definitions/IEdmStructuredType",
"readOnly":true
},
"name":{
"type":"string",
"readOnly":true
}
}
},
"IEdmStructuralProperty":{
"type":"object",
"properties":{
"defaultValueString":{
"type":"string",
"readOnly":true
},
"propertyKind":{
"format":"int32",
"enum":[
0,
1,
2
],
"type":"integer",
"readOnly":true
},
"type":{
"$ref":"#/definitions/IEdmTypeReference",
"readOnly":true
},
"declaringType":{
"$ref":"#/definitions/IEdmStructuredType",
"readOnly":true
},
"name":{
"type":"string",
"readOnly":true
}
}
},
"Calendar":{
"type":"object",
"properties":{
"dateHour":{
"format":"date-time",
"type":"string"
},
"calendarYear":{
"format":"int32",
"type":"integer"
},
"calendarYearDesc":{
"type":"string"
},
"calendarQtr":{
"format":"int32",
"type":"integer"
},
"calendarQtrDesc":{
"type":"string"
},
"calendarMonth":{
"format":"int32",
"type":"integer"
},
"calendarMonthDesc":{
"type":"string"
},
"calendarWeek":{
"format":"int32",
"type":"integer"
},
"calendarWeekDesc":{
"type":"string"
},
"dayOfYearNum":{
"format":"int32",
"type":"integer"
},
"dayOfWeekNum":{
"format":"int32",
"type":"integer"
},
"dayOfWeekDesc":{
"type":"string"
},
"dayOfMonthNum":{
"format":"int32",
"type":"integer"
},
"displayDayOfWeek":{
"type":"string"
},
"hourOfDayNum":{
"format":"int32",
"type":"integer"
},
"calendarMonthId":{
"format":"int32",
"type":"integer"
},
"calendarQtrId":{
"format":"int32",
"type":"integer"
},
"calendarWeekId":{
"format":"int32",
"type":"integer"
},
"calendarDayId":{
"format":"date-time",
"type":"string"
}
}
},
"ODataQueryOptions[LandingPageActivity]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"LandingPageActivity":{
"type":"object",
"properties":{
"averageLandingPageTime":{
"format":"double",
"type":"number",
"readOnly":true
},
"eloquaCampaignID":{
"format":"int32",
"type":"integer"
},
"landingPageID":{
"format":"int32",
"type":"integer"
},
"landingPageTime":{
"format":"double",
"type":"number"
},
"landingPageViews":{
"format":"int32",
"type":"integer"
},
"webClickDateHour":{
"format":"date-time",
"type":"string"
},
"totalVisitors":{
"format":"int32",
"type":"integer"
},
"totalVisits":{
"format":"int32",
"type":"integer"
},
"calendar":{
"$ref":"#/definitions/Calendar"
}
}
},
"ODataQueryOptions[LandingPageAsset]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"LandingPageAsset":{
"type":"object",
"properties":{
"landingPageID":{
"format":"int32",
"type":"integer"
},
"landingPageName":{
"type":"string"
},
"isDeleted":{
"type":"boolean"
},
"landingPageDescription":{
"type":"string"
},
"relativePath":{
"type":"string"
},
"landingPageCreatedByUserID":{
"format":"int32",
"type":"integer"
},
"landingPageModifiedByUserID":{
"format":"int32",
"type":"integer"
},
"lastModifiedDateTime":{
"format":"date-time",
"type":"string"
}
}
},
"ContactFieldRest10":{
"title":"ContactField",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the contact field. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The email footer's current status."
},
"name":{
"type":"string",
"description":"The name of the contact field."
},
"description":{
"type":"string",
"description":"The description of the contact field."
},
"permissions":{
"type":"string",
"description":"The permissions for the contact field granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the contact field. This is a read-only property."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the contact field was created, expressed in Unix time. This is a read-only property."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the contact field."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the contact field was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"internalName":{
"type":"string",
"description":"The contact field's internal name."
},
"optionListId":{
"type":"string",
"description":"The id of the associated option list."
},
"checkedValue":{
"type":"string",
"description":"The checked value."
},
"uncheckedValue":{
"type":"string",
"description":"The unchecked value of a checkbox custom object field."
},
"displayType":{
"type":"string",
"description":"The contact field's display type."
},
"dataType":{
"type":"string",
"description":"The contact field's data type. This is a read-only property."
},
"defaultValue":{
"type":"string",
"description":"The contact field's default value."
},
"isReadOnly":{
"type":"string",
"description":"Whether or not the contact field is read only."
},
"isRequired":{
"type":"string",
"description":"Whether or not the contact field is required."
},
"isStandard":{
"type":"string",
"description":"Whether or not the contact field is standard."
},
"outputFormatId":{
"type":"string",
"description":"The id of the output format."
},
"updateType":{
"type":"string",
"description":"Denotes under what circumstances the contact field is updated."
},
"showTrustedVisitorsOnly":{
"type":"string",
"description":"Whether or not a contact field is displayed only to trusted visitors."
},
"isPhoneValidationRequired":{
"type":"string",
"description":"ContactField_Field_IsPhoneValidationRequired_Description"
}
}
},
"QueryResultContactFieldRest10":{
"title":"QueryResultContactField",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of contact fields.",
"items":{
"$ref":"#/definitions/ContactFieldRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"SmsRest20":{
"title":"Sms",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the sms. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The sms's current status. This is a read-only property"
},
"description":{
"type":"string",
"description":"Description of the sms"
},
"permissions":{
"type":"array",
"description":"The permissions for the sms granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the sms"
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the asset."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the sms"
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the sms."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the sms was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the sms."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the sms."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the sms was last updated. This is a read-only property."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used"
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. For more information, see Request depth."
},
"name":{
"type":"string",
"description":"Name of the sms"
},
"content":{
"type":"string",
"description":"Sms Content"
},
"archived":{
"type":"string",
"description":"Whether or not the sms is archived"
},
"smsType":{
"type":"string",
"description":"Purpose of sms."
},
"initiationType":{
"type":"string",
"description":"Type of initiation"
},
"templateId":{
"type":"string",
"description":"Id of the template associated with the sms"
},
"senderCodes":{
"type":"array",
"description":"Sender codes associated with the sms",
"items":{
"$ref":"#/definitions/SmsSenderCodeRest20"
}
},
"fieldMerges":{
"type":"array",
"description":"Field Merges associated with the sms",
"items":{
"$ref":"#/definitions/FieldMergeRest20"
}
},
"hyperLinks":{
"type":"array",
"description":"Hyperlinks associated with the sms",
"items":{
"$ref":"#/definitions/SmsLinkRest20"
}
},
"keywordResponses":{
"type":"array",
"description":"Keyword responses associated with the sms",
"items":{
"$ref":"#/definitions/KeywordResponseRest20"
}
}
}
},
"QueryResultSmsRest20":{
"title":"QueryResultSms",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of sms fields.",
"items":{
"$ref":"#/definitions/SmsRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"SmsSenderCodeRest20":{
"title":"SmsSenderCode",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the sms sender code. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The sms sender code current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"Name of the sms sender code."
},
"description":{
"type":"string",
"description":"Description of the sms sender code."
},
"permissions":{
"type":"array",
"description":"The permissions for the sms sender code granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the sms sender code."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the asset."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the sms sender code."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the sms sender code."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the sms sender code was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the sms sender code."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the sms sender code."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the sms sender code was last updated. This is a read-only property."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used"
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. For more information, see Request depth."
},
"senderCodeId":{
"type":"string",
"description":"Id of the associated sender code."
},
"countryCode":{
"type":"string",
"description":"Associated country code."
},
"senderCode":{
"type":"string",
"description":"Associated sender code."
}
}
},
"FieldMergeRest20":{
"title":"FieldMerge",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the field merge. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The field merge's current status."
},
"name":{
"type":"string",
"description":"Name of the field merge."
},
"description":{
"type":"string",
"description":"The description of the field merge."
},
"permissions":{
"type":"array",
"description":"The permissions for the field merge granted to your current instance.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"Id of the associated folder."
},
"sourceTemplateId":{
"type":"string",
"description":"The id of the source template."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the field merge."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the field merge."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the field merge was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the field merge."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the field merge."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the field merge was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used for field merges."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"syntax":{
"type":"string",
"description":"The syntax of the field merge."
},
"defaultValue":{
"type":"string",
"description":"The default value of the field merge."
},
"contactFieldId":{
"type":"string",
"description":"Id of the associated contact field."
},
"accountFieldId":{
"type":"string",
"description":"Id of the associated account field."
},
"eventId":{
"type":"string",
"description":"Id of the associated event."
},
"eventFieldId":{
"type":"string",
"description":"Id of the associated event field."
},
"eventSessionFieldId":{
"type":"string",
"description":"Id of the associated event session field."
},
"customObjectId":{
"type":"string",
"description":"Id of the associated custom object."
},
"customObjectFieldId":{
"type":"string",
"description":"Id of the associated custom object field."
},
"mergeType":{
"type":"string",
"description":"Type of the field merge. Possible values include: contactField, accountField, eventField, eventSessionField, and customObjectField."
},
"customObjectSort":{
"type":"string",
"description":"The associated custom object sort type."
},
"queryStringKey":{
"type":"string",
"description":"The key value if the field merge contains a query string. See the Help Center to learn more about field merges with query strings. This is a read-only property. "
},
"fieldConditions":{
"type":"array",
"description":"Array of field condition fields.",
"items":{
"$ref":"#/definitions/FieldConditionRest20"
}
},
"allowUrlsInValue":{
"type":"string",
"description":"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."
}
}
},
"SmsLinkRest20":{
"title":"SmsLink",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the sms link. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The sms link current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"Name of the sms link."
},
"description":{
"type":"string",
"description":"Description of the sms link."
},
"permissions":{
"type":"array",
"description":"The permissions for the sms link granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the sms link."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the asset."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the sms link."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the sms link."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the sms link was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the sms link."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the sms link."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the sms link was last updated. This is a read-only property."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used"
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. For more information, see Request depth."
},
"href":{
"type":"string",
"description":"Url represented by sms link."
},
"hyperlinkType":{
"type":"string",
"description":"Type of hyperlink represented by sms link."
}
}
},
"KeywordResponseRest20":{
"title":"KeywordResponse",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the keyword response. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The keyword response current status. This is a read-only property"
},
"description":{
"type":"string",
"description":"Description of the keyword response."
},
"permissions":{
"type":"array",
"description":"The permissions for the keyword response granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the keyword response."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the asset."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the keyword response."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the keyword response."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the keyword response was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the keyword response."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the keyword response."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the keyword response was last updated. This is a read-only property."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used"
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. For more information, see Request depth."
},
"keyword":{
"type":"string",
"description":"Keyword associated with keyword response."
},
"response":{
"type":"string",
"description":"Response associated with the keyword."
},
"templateId":{
"type":"string",
"description":"Id of the template associated with the keyword response."
},
"keywordType":{
"type":"string",
"description":"The type of the keyword."
}
}
},
"FieldConditionRest20":{
"title":"FieldCondition",
"properties":{
"type":{
"type":"string"
},
"id":{
"type":"string",
"readOnly":true
},
"currentStatus":{
"type":"string"
},
"name":{
"type":"string"
},
"description":{
"type":"string"
},
"permissions":{
"type":"array",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true
},
"sourceTemplateId":{
"type":"string"
},
"createdBy":{
"type":"string",
"readOnly":true
},
"createdByName":{
"type":"string"
},
"createdAt":{
"type":"string",
"readOnly":true
},
"updatedBy":{
"type":"string",
"readOnly":true
},
"updatedByName":{
"type":"string"
},
"updatedAt":{
"type":"string",
"readOnly":true
},
"scheduledFor":{
"type":"string",
"readOnly":true
},
"depth":{
"type":"string",
"readOnly":true
},
"condition":{
"$ref":"#/definitions/ConditionRest20"
},
"fieldId":{
"type":"string"
}
}
},
"ConditionRest20":{
"title":"Condition",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
}
}
},
"UserRest20":{
"title":"User",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the user. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"This property is not used."
},
"name":{
"type":"string",
"description":"The name of the user. This is a read-only property."
},
"description":{
"type":"string",
"description":"The description of the user."
},
"permissions":{
"type":"array",
"description":"The permissions for the user granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the user. This is a read-only property."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of template used to create the user."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the user. This is a read-only property."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the user."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the user was created, expressed in Unix time. This is a read-only property."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the user. This is a read-only property."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the user."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the user was last updated. This is a read-only property."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This parameter is not used."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth. This is a read-only property."
},
"loginName":{
"type":"string",
"description":"The user's name used to login. This is a read-only property."
},
"emailAddress":{
"type":"string",
"description":"The user's email address."
},
"federationId":{
"type":"string",
"description":"The user's Federation Id."
},
"firstName":{
"type":"string",
"description":"The first name of the user."
},
"lastName":{
"type":"string",
"description":"The last name of the user."
},
"preferences":{
"$ref":"#/definitions/UserPreferencesRest20",
"description":"A list of user preferences."
},
"typePermissions":{
"type":"array",
"description":"A list of the user's type permissions.",
"items":{
"$ref":"#/definitions/TypePermissionRest20"
}
},
"capabilities":{
"type":"array",
"description":"A list of strings: the user's capabilities.",
"items":{
"type":"string"
}
},
"betaAccess":{
"type":"array",
"description":"A list of strings: beta programs the user can access.",
"items":{
"type":"string"
}
},
"defaultContactViewId":{
"type":"string",
"description":"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":{
"type":"string",
"description":"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":{
"type":"array",
"description":"The user's security groups.",
"items":{
"$ref":"#/definitions/SecurityGroupRest20"
}
},
"interfacePermissions":{
"type":"array",
"description":"A list of the user's interface permissions.",
"items":{
"$ref":"#/definitions/InterfacePermissionRest20"
}
},
"productPermissions":{
"type":"array",
"description":"A list of the user's product permissions.",
"items":{
"$ref":"#/definitions/ProductPermissionRest20"
}
},
"isUsingBrightenTemplate":{
"type":"string",
"description":"This parameter is not used."
},
"shortcuts":{
"type":"array",
"description":"This parameter is not used.",
"items":{
"type":"string"
}
},
"isDeleted":{
"type":"string",
"description":"Indicates if the user is deleted."
},
"isDisabled":{
"type":"string",
"readOnly":true,
"description":"Indicates if the user is disabled."
},
"jobTitle":{
"type":"string",
"description":"Job title of the user."
},
"companyDisplayName":{
"type":"string",
"description":"Name of the user's company to be displayed."
},
"companyUrl":{
"type":"string",
"description":"URL of the user's company."
},
"phone":{
"type":"string",
"description":"Phone number of the user."
},
"crmUsername":{
"type":"string",
"description":"User's identifier in default CRM."
},
"crmUserNames":{
"$ref":"#/definitions/crmUserNamesRest20",
"description":"List of CrmUsernames records. User's identifiers in internally supported CRMs."
},
"passwordExpires":{
"type":"string",
"description":"Indicates if user's password can expire."
},
"sendWelcomeEmail":{
"type":"string",
"description":"Indicates if \"User Welcome\" email would be sent to user upon user creation."
},
"cellPhone":{
"type":"string",
"description":"Mobile phone number of the user."
},
"address1":{
"type":"string",
"description":"User's address line 1."
},
"address2":{
"type":"string",
"description":"User's address line 2."
},
"replyToAddress":{
"type":"string",
"description":"User's email address used as \"reply to\" address."
},
"department":{
"type":"string",
"description":"Name of the user's department."
},
"fax":{
"type":"string",
"description":"Fax number of the user."
},
"personalUrl":{
"type":"string",
"description":"User's personal URL."
},
"personalMessage":{
"type":"string",
"description":"User's personal message."
},
"ssoOnly":{
"type":"string",
"description":"Indicates if the user can only login using Single Sign On."
},
"digitalSignatureId":{
"type":"string",
"description":"Internal id of user's digital signature."
},
"personalPhotoId":{
"type":"string",
"description":"Internal id of user's personal photo."
},
"city":{
"type":"string",
"description":"The name of the user's city."
},
"state":{
"type":"string",
"description":"The name of the user's state or province."
},
"country":{
"type":"string",
"description":"The name of the user's country."
},
"zipCode":{
"type":"string",
"description":"User's ZIP or postal code."
},
"senderEmailAddress":{
"type":"string",
"description":"User's \"Sender Email Address\""
},
"senderDisplayName":{
"type":"string",
"description":"User's \"Sender Display Name\""
},
"isAssetManager":{
"type":"string",
"description":"User_Field_IsAssetManager_Description"
}
}
},
"UserPasswordRest20":{
"title":"UserPassword",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"password":{
"type":"string",
"description":"The user's password."
},
"mustChangePassword":{
"type":"string",
"description":"Boolean to determine whether the user must change their password upon logging in."
}
}
},
"UserEnabledRest20":{
"title":"UserEnabled",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"enabled":{
"type":"string",
"description":"Whether or not the user's account is enabled or disabled. Set {\\\"enabled\\\":true} to enable a user, otherwise {\\\"enabled\\\":false}."
}
}
},
"QueryResultUserRest20":{
"title":"QueryResultUser",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of user fields.",
"items":{
"$ref":"#/definitions/UserRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"UserPreferencesRest20":{
"title":"UserPreferences",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"timezoneId":{
"type":"string",
"description":"The ID of the user's timezone in Eloqua."
}
}
},
"TypePermissionRest20":{
"title":"TypePermission",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"objectType":{
"type":"string",
"description":""
},
"permissions":{
"$ref":"#/definitions/TypePermissionsRest20",
"description":""
}
}
},
"SecurityGroupRest20":{
"title":"SecurityGroup",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the security group."
},
"description":{
"type":"string",
"description":"The description of the security group."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the security group."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the security group."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the security group was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the security group. This is a read-only property."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the security group."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the security group was last updated. This is a read-only property."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"name":{
"type":"string",
"description":"The name of the security group."
},
"acronym":{
"type":"string",
"description":"Acronym for the security group"
},
"isReadOnly":{
"type":"string",
"readOnly":true,
"description":"Indicates if the security group is read only."
},
"isEffective":{
"type":"string",
"readOnly":true,
"description":"Indicates if the security group is effective."
}
}
},
"InterfacePermissionRest20":{
"title":"InterfacePermission",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"interfaceCode":{
"type":"string",
"description":""
},
"nestedInterfacePermissions":{
"type":"array",
"description":"",
"items":{
"$ref":"#/definitions/InterfacePermissionRest20"
}
},
"name":{
"type":"string",
"description":""
}
}
},
"ProductPermissionRest20":{
"title":"ProductPermission",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"productCode":{
"type":"string",
"description":""
}
}
},
"crmUserNamesRest20":{
"title":"crmUserNames",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"SFDCUserName":{
"type":"string",
"description":""
},
"MSDUserName":{
"type":"string",
"description":""
},
"SODUserName":{
"type":"string",
"description":""
}
}
},
"TypePermissionsRest20":{
"title":"TypePermissions",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
}
}
},
"ExternalActivitiesRest20":{
"title":"ExternalActivities",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the external activity. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The external activity's current status."
},
"name":{
"type":"string",
"description":"The name of the external activity."
},
"description":{
"type":"string",
"description":"The description of the external activity."
},
"permissions":{
"type":"array",
"description":"The permissions for the external activity granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the external activity."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the external activity."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the external activity."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the external activity."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the external activity was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the external activity."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the external activity."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the external activity was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the external activity is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"campaignId":{
"type":"integer",
"description":"Id of the associated campaign. This value must correspond to a valid campaign."
},
"assetName":{
"type":"string",
"description":"The name of the associated asset."
},
"assetType":{
"type":"string",
"description":"The type of the associated asset."
},
"activityType":{
"type":"string",
"description":"The activity's type."
},
"activityDate":{
"type":"string",
"description":"The date the external activity was performed by the associated contact."
},
"contactId":{
"type":"integer",
"description":"The id of the contact who performed the activity. This value must correspond to a valid contact."
},
"fieldValues":{
"type":"array",
"description":"Array containing type and id values for all of the activity fields associated with a given external activity",
"items":{
"type":"object",
"additionalProperties":{
"type":"string"
}
}
}
}
},
"UserRest10":{
"title":"User",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the user. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"This property is not used."
},
"name":{
"type":"string",
"description":"The name of the user. This is a read-only property."
},
"description":{
"type":"string",
"description":"The description of the user. This is a read-only property."
},
"permissions":{
"type":"string",
"description":"The permissions for the user granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the user. This is a read-only property."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the user was created, expressed in Unix time. This is a read-only property."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the user. This is a read-only property."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the user was last updated. This is a read-only property."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"loginName":{
"type":"string",
"description":"The user's name used to login. This is a read-only property."
},
"company":{
"type":"string",
"description":"The name of the user's company/instance. This is a read-only property."
},
"emailAddress":{
"type":"string",
"description":"The user's email address. This is a read-only property."
},
"preferences":{
"$ref":"#/definitions/UserPreferencesRest10",
"description":"A list of user preferences. \"timezoneID\" is identifies the user's timezone preference."
},
"defaultContactViewId":{
"type":"string",
"description":"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":{
"type":"string",
"description":"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."
}
}
},
"QueryResultUserRest10":{
"title":"QueryResultUser",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of user fields.",
"items":{
"$ref":"#/definitions/UserRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"UserPreferencesRest10":{
"title":"UserPreferences",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"timezoneId":{
"type":"string",
"description":"The ID of the user's timezone in Eloqua. This is a read-only property."
}
}
},
"AccountGroupRest20":{
"title":"AccountGroup",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the account group."
},
"currentStatus":{
"type":"string",
"description":"The account group's current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"The account group's name."
},
"description":{
"type":"string",
"description":"The description of the account group."
},
"permissions":{
"type":"array",
"description":"The permissions for the account group granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the account group."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the account group."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the account group."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the account group."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the account group was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the account group."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the account group."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the account group was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the account group is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"count":{
"type":"string",
"description":"The number of companies within the account group. This is a read-only property."
},
"isArchived":{
"type":"string",
"description":"The account group is archived or not. This is a read-only property."
}
}
},
"QueryResultAccountGroupRest20":{
"title":"QueryResultAccountGroup",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of account group fields.",
"items":{
"$ref":"#/definitions/AccountGroupRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"QueryResultRuleMappingRest20":{
"title":"QueryResultRuleMapping",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of signature rule mappings.",
"items":{
"$ref":"#/definitions/EmailSignatureRuleMappingRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"EmailSignatureRuleMappingRest20":{
"title":"EmailSignatureRuleMapping",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"matchValue":{
"type":"string",
"description":"The value to be used for comparison."
},
"senderId":{
"type":"string",
"description":"The id of the user that will be used as the sender if the contact's field value matches the match value."
}
}
},
"ContactSegmentRest20":{
"title":"ContactSegment",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the contact segment. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"This property is not used for contact segments."
},
"name":{
"type":"string",
"description":"The contact segment's name."
},
"description":{
"type":"string",
"description":"This property is not used for contact segments."
},
"permissions":{
"type":"array",
"description":"The permissions for the contact segment granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the contact segment."
},
"sourceTemplateId":{
"type":"string",
"description":"This property is not used for contact segments."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the contact segment."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the contact segment."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the contact segment was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the contact segment."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the contact segment."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the contact segment was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used for contact segments."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"elements":{
"type":"array",
"description":"Array of contact segment elements.",
"items":{
"$ref":"#/definitions/SegmentElementRest20"
}
},
"count":{
"type":"string",
"description":"The number of contacts in the contact segment. This is a read-only property."
},
"lastCalculatedAt":{
"type":"string",
"description":"The date and time of the most recent calculation. This is a read-only property."
},
"isStale":{
"type":"string",
"description":"Whether or not the contact segment has been refreshed in the last 24 hours by the user performing the request."
},
"dependencyName":{
"type":"string",
"description":"Segment_Field_DependencyName_Description"
}
}
},
"QueryResultSegmentRest20":{
"title":"QueryResultSegment",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of contact segment fields.",
"items":{
"$ref":"#/definitions/ContactSegmentRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"SegmentElementRest20":{
"title":"SegmentElement",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the contact segment element. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The contact segment element's current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"This property is not used for contact segment elements."
},
"description":{
"type":"string",
"description":"This property is not used for contact segment elements."
},
"permissions":{
"type":"array",
"description":"The permissions for the contact segment element granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the contact segment element."
},
"sourceTemplateId":{
"type":"string",
"description":"This property is not used for contact segment elements."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the contact segment element."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the contact segment element."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the contact segment element was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the contact segment element."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the contact segment element."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the contact segment element was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used for contact segment elements."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"isIncluded":{
"type":"string",
"description":"The total amount of contacts within the segment element."
},
"count":{
"type":"string",
"description":"The number of contacts in the contact segment element. This is a read-only property."
},
"lastCalculatedAt":{
"type":"string",
"description":"The date and time the contact segment element was last calculated. This is a read-only property."
}
}
},
"ContactRest10":{
"title":"Contact",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the contact. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The contact's current status."
},
"name":{
"type":"string",
"description":"The name of the contact."
},
"description":{
"type":"string",
"description":"The description of the contact."
},
"permissions":{
"type":"string",
"description":"The permissions for the contact granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the contact."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the contact was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the contact."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the contact was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"firstName":{
"type":"string",
"description":"The contact's first name."
},
"lastName":{
"type":"string",
"description":"The contact's last name."
},
"emailAddress":{
"type":"string",
"description":"The contact's email address."
},
"emailFormatPreference":{
"type":"string",
"description":"The contact's email format preference."
},
"isSubscribed":{
"type":"string",
"description":"Whether or not the contact is subscribed."
},
"isBounceback":{
"type":"string",
"description":"Whether or not the contact has any associated bouncebacks."
},
"accountName":{
"type":"string",
"description":"The account name in which the contact belongs."
},
"accountId":{
"type":"string",
"description":"The account id in which the contact belongs. This is a read-only property."
},
"title":{
"type":"string",
"description":"The contact's title."
},
"subscriptionDate":{
"type":"string",
"description":"The contact's subscription date."
},
"unsubscriptionDate":{
"type":"string",
"description":"The contact's unsubscription date."
},
"bouncebackDate":{
"type":"string",
"description":"The contact's bounceback date."
},
"fieldValues":{
"type":"array",
"description":"Array containing type and id values for all of the contactFields associated with a given contact.",
"items":{
"$ref":"#/definitions/FieldValueRest10"
}
},
"address1":{
"type":"string",
"description":"The contact's first address."
},
"address2":{
"type":"string",
"description":"The contact's second address."
},
"address3":{
"type":"string",
"description":"The contact's third address."
},
"city":{
"type":"string",
"description":"The contact's city."
},
"province":{
"type":"string",
"description":"The contact's province."
},
"postalCode":{
"type":"string",
"description":"The contact's postal code."
},
"country":{
"type":"string",
"description":"The contact's country."
},
"businessPhone":{
"type":"string",
"description":"The contact's business phone number."
},
"mobilePhone":{
"type":"string",
"description":"The contact's mobile phone number."
},
"fax":{
"type":"string",
"description":"The contact's fax number."
},
"salesPerson":{
"type":"string",
"description":"The contact's account representative."
}
}
},
"QueryResultContactRest10":{
"title":"QueryResultContact",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of contact fields.",
"items":{
"$ref":"#/definitions/ContactRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"FieldValueRest10":{
"title":"FieldValue",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"value":{
"type":"string",
"description":"The value to set the corresponding field id to. Date values must be submitted as a unix timestamp."
},
"id":{
"type":"string",
"readOnly":true,
"description":"The id of the field to be set to the corresponding value."
}
}
},
"CustomObjectDataRest10":{
"title":"CustomObjectData",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the custom object. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The custom object's current status. This is a read-only property."
},
"contactId":{
"type":"string",
"description":"Id of the contact. This is a read-only property."
},
"fieldValues":{
"type":"array",
"description":"Array containing type and id 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.",
"items":{
"$ref":"#/definitions/FieldValueRest10"
}
}
}
},
"QueryResultCustomObjectDataRest10":{
"title":"QueryResultCustomObjectData",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of custom object field elements.",
"items":{
"$ref":"#/definitions/CustomObjectDataRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"QueryResultKeywordRest20":{
"title":"QueryResultKeyword",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of keyword fields.",
"items":{
"$ref":"#/definitions/KeywordRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"ODataQueryOptions[ExternalActivities]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"ExternalActivities":{
"type":"object",
"properties":{
"externalActivitiesId":{
"format":"int32",
"type":"integer"
},
"externalAssetId":{
"format":"int32",
"type":"integer"
},
"externalActivity":{
"type":"string"
},
"contactId":{
"format":"int32",
"type":"integer"
},
"campaignId":{
"format":"int32",
"type":"integer"
},
"externalActivityDate":{
"format":"date-time",
"type":"string"
},
"createdDate":{
"format":"date-time",
"type":"string"
},
"accountID":{
"format":"int32",
"type":"integer"
},
"eloquaLinkedAccountID":{
"format":"int32",
"type":"integer"
}
}
},
"ODataQueryOptions[ExternalActivityAttributes]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"ExternalActivityAttributes":{
"type":"object",
"properties":{
"externalAssetId":{
"format":"int32",
"type":"integer"
},
"externalAssetType":{
"format":"int32",
"type":"integer"
},
"externalAssetName":{
"type":"string"
},
"externalAssetTypeName":{
"type":"string"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
}
}
},
"ActivityRest10":{
"title":"Activity",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"description":"Id of the activity. This is a read-only property."
},
"contact":{
"type":"string",
"description":"Id of the contact whose activity is being returned expressed in 10 digit integer Unix time. This is a read-only property."
},
"activityType":{
"type":"string",
"description":"The activity's type. This is a read-only property."
},
"activityDate":{
"type":"string",
"description":"The date the activity was performed expressed in 10 digit integer Unix time. This is a read-only property."
},
"asset":{
"type":"string",
"description":"Id of the associated asset. This is a read-only property."
},
"assetType":{
"type":"string",
"description":"Type of the associated asset. This is a read-only property."
},
"isPending":{
"type":"string",
"description":"Activity_Field_IsPending_Description"
},
"details":{
"type":"array",
"description":"An array of detail values, specific to individual activity types.",
"items":{
"type":"object",
"additionalProperties":{
"type":"string"
}
}
}
}
},
"EventField":{
"title":"EventField",
"description":"The definition of a field on the referenced Event object.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity.",
"type":"string"
},
"dataType":{
"$ref":"#/definitions/DataType"
},
"defaultValue":{
"title":"defaultValue",
"description":"The field's default value.",
"type":"string"
},
"hasNotNullConstraint":{
"title":"hasNotNullConstraint",
"description":"Indicates whether the field can have null values (i.e. empty).",
"type":"boolean"
},
"hasReadOnlyConstraint":{
"title":"hasReadOnlyConstraint",
"description":"Indicates whether the field can be written to.",
"type":"boolean"
},
"hasUniquenessConstraint":{
"title":"hasUniquenessConstraint",
"description":"Indicates whether the field must have a unique value.",
"type":"boolean"
},
"internalName":{
"title":"internalName",
"description":"The field's internal name (used to uniquely identify it).",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the custom object definition.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"Event":{
"title":"Event",
"description":"The definition of an Event. Eloqua Event Management simplifies the process of marketing event registration.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity.",
"type":"string"
},
"displayNameFieldUri":{
"title":"displayNameFieldUri",
"description":"The relative uri used to reference the event field that represents the display field, for this event.",
"type":"string"
},
"emailAddressFieldUri":{
"title":"emailAddressFieldUri",
"description":"The relative uri used to reference the event field that represents an email address, for this event.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the event definition.",
"type":"string"
},
"uniqueFieldUri":{
"title":"uniqueFieldUri",
"description":"The relative uri used to reference the event field that has a uniqueness constraint on it, for this event.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing.",
"type":"string"
}
}
},
"QueryResultCountryRest20":{
"title":"QueryResultCountry",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"elements":{
"type":"array",
"description":"Array of countries.",
"items":{
"$ref":"#/definitions/CountryRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"CountryRest20":{
"title":"Country",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the country. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"This property is not used."
},
"name":{
"type":"string",
"description":"This parameter is not used."
},
"description":{
"type":"string",
"description":"This parameter is not used."
},
"permissions":{
"type":"array",
"description":"This parameter is not used.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"This parameter is not used."
},
"sourceTemplateId":{
"type":"string",
"description":"This parameter is not used."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"This parameter is not used."
},
"createdByName":{
"type":"string",
"description":"This parameter is not used."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"This parameter is not used."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"This parameter is not used."
},
"updatedByName":{
"type":"string",
"description":"This parameter is not used."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"This parameter is not used."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This parameter is not used."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"This parameter is not used."
},
"countryCode":{
"type":"string",
"description":"The country code of the country."
},
"countryName":{
"type":"string",
"description":"The name of the country."
}
}
},
"LandingPageRest20":{
"title":"LandingPage",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the landing page. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The landing page's current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"The name of the landing page."
},
"description":{
"type":"string",
"description":"The description of the landing page."
},
"permissions":{
"type":"array",
"description":"The permissions for the landing page granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the landing page."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the landing page."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the landing page."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the landing page."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the landing page was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the landing page."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the landing page."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the landing page was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"deployedAt":{
"type":"string",
"description":"Unix timestamp for the date and time the landing page was deployed. This is a read-only property."
},
"micrositeId":{
"type":"string",
"description":"Id of the associated microsite."
},
"refreshedAt":{
"type":"string",
"description":"Unix timestamp for the date and time the landing page was last refreshed. This is a read-only property."
},
"htmlContent":{
"$ref":"#/definitions/HtmlContentRest20",
"description":"The landing page's raw html content."
},
"layout":{
"type":"string",
"description":"The landing page's main layout."
},
"style":{
"type":"string",
"description":"The landing page's main layout style."
},
"forms":{
"type":"array",
"description":"A list of forms contained within the landing page.",
"items":{
"$ref":"#/definitions/FormRest20"
}
},
"images":{
"type":"array",
"description":"A list of images contained within the landing page.",
"items":{
"$ref":"#/definitions/ImageFileRest20"
}
},
"hyperlinks":{
"type":"array",
"description":"A list of hyperlinks contained within the landing page.",
"items":{
"$ref":"#/definitions/HyperlinkRest20"
}
},
"contentSections":{
"type":"array",
"description":"A list of content sections contained within the landing page.",
"items":{
"$ref":"#/definitions/ContentSectionRest20"
}
},
"dynamicContents":{
"type":"array",
"description":"A list of dynamic contents contained within the landing page.",
"items":{
"$ref":"#/definitions/DynamicContentRest20"
}
},
"files":{
"type":"array",
"description":"A list of files contained within the landing page.",
"items":{
"$ref":"#/definitions/ImportedFileRest20"
}
},
"contentServiceInstances":{
"type":"array",
"description":"",
"items":{
"$ref":"#/definitions/CloudComponentInstanceRest20"
}
},
"autoRedirectUrl":{
"type":"string",
"description":"The URL to redirect window used with autoRedirectWaitFor."
},
"autoRedirectWaitFor":{
"type":"string",
"description":"Amount of seconds to automatically redirect window to URL specified with autoRedirectUrl. This setting cannot be used with autoCloseWaitFor. Only one can be selected, and a validation error will be returned if including both."
},
"autoCloseWaitFor":{
"type":"string",
"description":"Amount of seconds to automatically close window. This setting cannot be used with autoRedirectWaitFor. Only one can be selected, and a validation error will be returned if including both."
},
"relativePath":{
"type":"string",
"description":"The relative path of the landing page."
},
"excludeFromAuthentication":{
"type":"string",
"description":"Whether or not the landing page is excluded from authentication."
},
"isContentProtected":{
"type":"string",
"description":"Whether or not the landing page is in protected mode."
},
"isHidden":{
"type":"string",
"description":"Whether or not the landing page is visible to external visitors."
},
"thumbnailUrl":{
"type":"string",
"description":"LandingPage_Field_ThumbnailUrl_Description"
},
"expiresAt":{
"type":"string",
"description":"LandingPage_Field_ExpiresAt_Description"
},
"expiryRedirectUrl":{
"type":"string",
"description":"LandingPage_Field_ExpiryRedirectUrl_Description"
},
"isExpiryEnabled":{
"type":"string",
"description":"LandingPage_Field_IsExpiryEnabled_Description"
},
"displayTimeZoneId":{
"type":"string",
"description":"LandingPage_Field_DisplayTimeZoneId_Description"
}
}
},
"QueryResultLandingPageRest20":{
"title":"QueryResultLandingPage",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of landing page fields.",
"items":{
"$ref":"#/definitions/LandingPageRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"HtmlContentRest20":{
"title":"HtmlContent",
"properties":{
"type":{
"type":"string"
},
"contentSource":{
"type":"string"
}
}
},
"FormRest20":{
"title":"Form",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the form."
},
"currentStatus":{
"type":"string",
"description":"The form's current status. Example: draft, active, or complete."
},
"name":{
"type":"string",
"description":"The name of the form."
},
"description":{
"type":"string",
"description":"The description of the form."
},
"permissions":{
"type":"array",
"description":"The permissions for the form granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The ID of the containing folder."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the source template."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login ID of the user who created the form."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the form."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the form was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login ID of the user that last updated the form."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the form."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the form was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"htmlName":{
"type":"string",
"description":"The asset's raw HTML name."
},
"processingType":{
"type":"string",
"description":"A list of the form's processing types. For example: externalEmail, externalWebsite, internallyHosted, internalAgentProxyForm."
},
"submitFailedLandingPageId":{
"type":"string",
"description":"The landing page ID of the failed submit."
},
"size":{
"$ref":"#/definitions/SizeRest20",
"description":"The size dimensions of the form."
},
"html":{
"type":"string",
"description":"The asset's raw HTML content."
},
"style":{
"type":"string",
"description":"The asset's main layout style."
},
"elements":{
"type":"array",
"description":"Array consisting of form elements.",
"items":{
"$ref":"#/definitions/FormElementRest20"
}
},
"processingSteps":{
"type":"array",
"description":"A list of the form's processing steps. There is no limit to the number of processing steps that can be included. Possible values include: FormStepAddToCampaign, FormStepAddToContactList, FormStepAddToDataCanvas, FormStepAddToProgram, FormStepAssociateToCampaign, FormStepCancelRegistration, FormStepUpdateContactEmailAddress, FormStepCreateUpdateEventRegistration, FormStepCreateUpdate, FormStepCreateUpdateFromFormField, FormStepGlobalSubscribe, FormStepGlobalUnsubscribe, FormStepGroupSubscription, FormStepPostData, FormStepRedirectToWebPage, FormStepRemoveFromContactList, FormStepRunIntegrationRules, FormStepSendEmail, FormStepSendNotificationEmail, FormStepWebTracking, FormStepGlobalSubscribe, and FormStepSmsPhoneNumberOptInOptOut.",
"items":{
"$ref":"#/definitions/FormProcessingStepRest20"
}
},
"defaultKeyFieldMapping":{
"$ref":"#/definitions/FormFieldUpdateMappingRest20",
"description":"The default key field mapping for the form."
},
"externalIntegrationUrl":{
"type":"string",
"description":"The external integration URL used for integrating external forms."
},
"customCSS":{
"type":"string",
"description":"The custom style applied to the form."
},
"isHidden":{
"type":"string",
"description":"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":{
"type":"string",
"description":"Form metadata in JSON. Applicable only to responsive forms. Not required to be set when creating and updating forms. We recommend omitting this parameter when creating and updating forms, and letting Eloqua set it by default. When creating a form and including this parameter, this must be set to {\\\"type\\\":\\\"responsiveForm\\\",\\\"version\\\":\\\"1\\\"}."
},
"isResponsive":{
"type":"string",
"description":"Indicates whether the form is responsive. Returns true for a responsive form, false for a legacy form. Avoid sending this property when creating and updating forms. This is a read-only property."
},
"archived":{
"type":"string",
"description":"True if form is archived otherwise False. This is a read-only property."
},
"isFormSpamProtectionEnabled":{
"type":"string",
"description":"Indicates whether spam protection is enabled on the form."
}
}
},
"ImageFileRest20":{
"title":"ImageFile",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the image."
},
"currentStatus":{
"type":"string",
"description":"The image's current status."
},
"name":{
"type":"string",
"description":"The name of the image."
},
"description":{
"type":"string",
"description":"The description of the image."
},
"permissions":{
"type":"array",
"description":"The permissions for the image granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"Id of the folder."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the source template."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the image."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the image."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the image was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the image."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the image."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the image was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date and time the image is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"fullImageUrl":{
"type":"string",
"description":"The image's complete URL. This is a read-only property."
},
"size":{
"$ref":"#/definitions/SizeRest20",
"description":"The size of the image."
},
"thumbnailUrl":{
"type":"string",
"description":"The image's thumbnail URL. This is a read-only property."
},
"source":{
"type":"string",
"description":"The image's source location."
},
"syncDate":{
"type":"string",
"description":"The date and time the image was last synced, expressed in Unix time. This is a read-only property."
}
}
},
"HyperlinkRest20":{
"title":"Hyperlink",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the hyperlink. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The hyperlink's current status."
},
"name":{
"type":"string",
"description":"Name of the hyperlink."
},
"description":{
"type":"string",
"description":"The description of the hyperlink."
},
"permissions":{
"type":"array",
"description":"The permissions for the hyperlink granted to your current instance.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"Id of the containing folder."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the source template."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the hyperlink."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the hyperlink."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the hyperlink was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the hyperlink."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the hyperlink."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the hyperlink was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the hyperlink is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"href":{
"type":"string",
"description":"Href value of the hyperlink."
},
"hyperlinkType":{
"type":"string",
"description":"The type of hyperlink. Possible values include: ExternalURL, ICSCalendarURL, LandingPageURL, ReferrerURL, RSSURL, or TrackedExternalURL."
},
"referencedEntityId":{
"type":"string",
"description":"Id of the referenced entity."
}
}
},
"ContentSectionRest20":{
"title":"ContentSection",
"properties":{
"type":{
"type":"string",
"description":"The content section's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the content section. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The content section's current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"The name of the content section."
},
"description":{
"type":"string",
"description":"The description of the content section."
},
"permissions":{
"type":"array",
"description":"The permissions for the content section granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the content section."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the asset."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the content section."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the content section."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the content section was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the content section."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the content section."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the content section was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the content section is scheduled. This is a read-only property."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"contentHtml":{
"type":"string",
"description":"The content section's HTML content."
},
"contentText":{
"type":"string",
"description":"The content section's text content."
},
"scope":{
"type":"string",
"description":"The content sections's scope: either local or global."
},
"forms":{
"type":"array",
"description":"A list of associated Form assets.",
"items":{
"$ref":"#/definitions/FormRest20"
}
},
"images":{
"type":"array",
"description":"A list of associated Image assets.",
"items":{
"$ref":"#/definitions/ImageFileRest20"
}
},
"hyperlinks":{
"type":"array",
"description":"A list of hyperlinks contained within the content section.",
"items":{
"$ref":"#/definitions/HyperlinkRest20"
}
},
"files":{
"type":"array",
"description":"A list of associated files.",
"items":{
"$ref":"#/definitions/ImportedFileRest20"
}
},
"size":{
"$ref":"#/definitions/SizeRest20",
"description":"Generally contains 3 fields: type, width and height. \"type\" should be set to \"Size\", and width and height can be set to the content section's desired dimensions."
}
}
},
"DynamicContentRest20":{
"title":"DynamicContent",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the dynamic content. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The dynamic content's current status."
},
"name":{
"type":"string",
"description":"Name of the dynamic content."
},
"description":{
"type":"string",
"description":"The description of the dynamic content."
},
"permissions":{
"type":"array",
"description":"The permissions for the dynamic content granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The id of the associated folder."
},
"sourceTemplateId":{
"type":"string",
"description":"The id of the source template."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the dynamic content."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the dynamic content."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the dynamic content was last accessed, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the dynamic content."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the dynamic content."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the dynamic content was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the dynamic content is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"defaultContentSection":{
"$ref":"#/definitions/ContentSectionRest20",
"description":"The default content section of the dynamic content."
},
"rules":{
"type":"array",
"description":"The dynamic content's rules.",
"items":{
"$ref":"#/definitions/DynamicContentRuleRest20"
}
},
"isContentPublic":{
"type":"boolean",
"description":"Whether or not the dynamic content is public."
}
}
},
"ImportedFileRest20":{
"title":"ImportedFile",
"properties":{
"type":{
"type":"string",
"description":"The date and time the imported file was last accessed. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the imported file. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The imported file's current status."
},
"name":{
"type":"string",
"description":"Name of the imported file."
},
"description":{
"type":"string",
"description":"The description of the imported file."
},
"permissions":{
"type":"array",
"description":"The permissions for the imported file granted to your current instance.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"Id of the folder. This is a read-only property."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the source template. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the imported file."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the imported file."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the imported file was last accessed, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the imported file."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the imported file."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the imported file was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date and time the file is scheduled for. This is a read-only property."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"fileName":{
"type":"string",
"description":"The file name of the imported file."
},
"link":{
"type":"string",
"description":"The imported file's complete URL. This is a read-only property."
},
"trackedLink":{
"type":"string",
"description":"The imported file's tracked complete URL. This is a read-only property."
},
"redirectLink":{
"type":"string",
"description":"The imported file's redirect URL. This is a read-only property."
},
"brandId":{
"type":"string",
"description":"ImportedFile_Field_BrandId_Description"
}
}
},
"CloudComponentInstanceRest20":{
"title":"CloudComponentInstance",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"id":{
"type":"string",
"description":"The cloud content's unique identifier."
},
"componentId":{
"type":"string",
"description":"The component id of the cloud content."
},
"configurationUrl":{
"type":"string",
"readOnly":true,
"description":"The configuration URL for the cloud content."
},
"configurationUrlModalSize":{
"type":"string",
"description":"The modal size of the configuration window. Possible values are large or small."
},
"editorImageUrl":{
"type":"string",
"description":"The image url for an image that Eloqua will display in the editor's design surface. editorImageUrl is not a templated URL."
},
"height":{
"$ref":"#/definitions/System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]Rest20",
"description":"The height dimension of the cloud content element."
},
"width":{
"$ref":"#/definitions/System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]Rest20",
"description":"The width dimension of the cloud content element."
},
"enabledConfigStatus":{
"type":"string",
"description":"Whether or not the cloud content is configured. Possible values include: None, Installing, EnableProcess, Error, Ready, Disabled, DisabledError, MarkedForDeletion."
},
"appStatus":{
"type":"string",
"description":"The status of the cloud content. Possible values include: Up, Down, and Maintenance."
},
"requiresConfiguration":{
"type":"string",
"description":"Whether user configuration is required before the cloud content can be used. If set to true, users will be unable to save an email or landing page asset containing the unconfigured app service instance. Eloqua will display an error message."
}
}
},
"SizeRest20":{
"title":"Size",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. The type for this property is 'size'."
},
"width":{
"type":"string",
"description":"The width dimensions of the asset expressed in pixels."
},
"height":{
"type":"string",
"description":"The height dimensions of the asset expressed in pixels."
}
}
},
"FormElementRest20":{
"title":"FormElement",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"The ID of the form element. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The form element's current status."
},
"name":{
"type":"string",
"description":"Name of the form element."
},
"description":{
"type":"string",
"description":"The description of the form element."
},
"permissions":{
"type":"array",
"description":"The permissions for the form element granted to your current instance.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The ID of the associated folder."
},
"sourceTemplateId":{
"type":"string",
"description":"The ID of the form element."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login ID of the user who created the form element."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the form element."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the form element was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login ID of the user that last updated the form element."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the form element."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the form element was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the form element is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"instructions":{
"type":"string",
"description":"The form element's field instructions. Field instructions are optional instructions that help users fill in fields."
},
"style":{
"type":"string",
"description":"The asset's main layout style."
}
}
},
"FormProcessingStepRest20":{
"title":"FormProcessingStep",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the form processing step. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The form processing step's current status."
},
"name":{
"type":"string",
"description":"Name of the form processing step."
},
"permissions":{
"type":"array",
"description":"The permissions for the form processing step granted to your current instance.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"Id of the associated folder."
},
"sourceTemplateId":{
"type":"string",
"description":"The ID of the source template."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login ID of the user who created the form processing step."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the form processing step."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the form processing step was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login ID of the user that last updated the form processing step."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the form processing step."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the form processing step was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the form processing step is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"execute":{
"type":"string",
"description":"The conditions for which this form processing step will execute. Possible values include: always, conditionally, and never."
},
"condition":{
"$ref":"#/definitions/ProcessingStepConditionRest20",
"description":"ProcessingStep_Field_ProcessingStepCondition_Description"
},
"description":{
"type":"string",
"description":"The description of the form processing step."
},
"hasValidationIssue":{
"type":"string",
"description":"ProcessingStep_Field_HasValidationIssue_Description"
}
}
},
"FormFieldUpdateMappingRest20":{
"title":"FormFieldUpdateMapping",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the form field update mapping."
},
"currentStatus":{
"type":"string",
"description":"The form field update mapping's current status."
},
"name":{
"type":"string",
"description":"The name of the form field update mapping."
},
"description":{
"type":"string",
"description":"The description of the field comparison criteria."
},
"permissions":{
"type":"array",
"description":"The permissions for the form field update mapping granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"Id of the folder. This is a read-only property."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the source template. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the form field update mapping."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the form field update mapping."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the form field update mapping was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the form field update mapping."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the form field update mapping."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the form field update mapping was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date and time the form field update mapping is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"sourceFormFieldId":{
"type":"string",
"description":"Id of the source form field. "
},
"updateType":{
"type":"string",
"description":"The update type of the form field update mapping."
},
"targetEntityFieldId":{
"type":"string",
"description":"Id of the target field."
}
}
},
"DynamicContentRuleRest20":{
"title":"DynamicContentRule",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The Dynamic Content Rule 's current status."
},
"id":{
"type":"string",
"description":"Id of the dynamic content rule. This is a read-only property."
},
"depth":{
"type":"string",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"contentSection":{
"$ref":"#/definitions/ContentSectionRest20",
"description":"A list of associated Content Section assets."
},
"criteria":{
"type":"array",
"description":"The criteria of the dynamic content rule.",
"items":{
"$ref":"#/definitions/CriterionRest20"
}
},
"statement":{
"type":"string",
"description":"The statement of the dynamic content rule."
},
"name":{
"type":"string",
"description":"The name of the dynamic content rule."
}
}
},
"ProcessingStepConditionRest20":{
"title":"ProcessingStepCondition",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"isConditionallyNegated":{
"type":"string",
"description":"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":{
"type":"array",
"description":"The conditional field criteria for the form processing step condition.",
"items":{
"$ref":"#/definitions/FieldComparisonCriteriaRest20"
}
}
}
},
"CriterionRest20":{
"title":"Criterion",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the criterion. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The criterion's current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"Name of the criterion."
},
"description":{
"type":"string",
"description":"The description of the criterion."
},
"permissions":{
"type":"array",
"description":"The permissions for the criterion granted to your current instance.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"Id of the folder. This is a read-only property."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the source template. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the criterion."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the criterion."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the criterion was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the criterion."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the criterion."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the criterion was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date and time the criterion is scheduled for."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
}
}
},
"FieldComparisonCriteriaRest20":{
"title":"FieldComparisonCriteria",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the field comparison criteria."
},
"currentStatus":{
"type":"string",
"description":"The field comparison criteria's current status."
},
"name":{
"type":"string",
"description":"The name of the field comparison criteria."
},
"description":{
"type":"string",
"description":"The description of the field comparison criteria."
},
"permissions":{
"type":"array",
"description":"The permissions for the field comparison criteria granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"Id of the folder. This is a read-only property."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the source template. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the field comparison criteria."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the field comparison criteria."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the field comparison criteria was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the field comparison criteria."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the field comparison criteria."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the field comparison criteria was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date and time the field comparison criteria is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"fieldId":{
"type":"string",
"description":"The id of the field comparison criteria."
},
"condition":{
"$ref":"#/definitions/ConditionRest20",
"description":"The condition of the field comparison criteria."
}
}
},
"CampaignField":{
"title":"CampaignField",
"description":"The definition of a campaign field in the system.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataType":{
"$ref":"#/definitions/DataType"
},
"defaultValue":{
"title":"defaultValue",
"description":"The field's default value.",
"type":"string"
},
"hasNotNullConstraint":{
"title":"hasNotNullConstraint",
"description":"Indicates whether the field can have null values (i.e. empty).",
"type":"boolean"
},
"hasReadOnlyConstraint":{
"title":"hasReadOnlyConstraint",
"description":"Indicates whether the field can be written to.",
"type":"boolean"
},
"hasUniquenessConstraint":{
"title":"hasUniquenessConstraint",
"description":"Indicates whether the field must have a unique value.",
"type":"boolean"
},
"internalName":{
"title":"internalName",
"description":"The field's internal name (used to uniquely identify it).",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the campaign field definition.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"AccountField":{
"title":"AccountField",
"description":"The definition of a field on all accounts in the system.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataType":{
"$ref":"#/definitions/DataType"
},
"defaultValue":{
"title":"defaultValue",
"description":"The field's default value.",
"type":"string"
},
"hasNotNullConstraint":{
"title":"hasNotNullConstraint",
"description":"Indicates whether the field can have null values (i.e. empty).",
"type":"boolean"
},
"hasReadOnlyConstraint":{
"title":"hasReadOnlyConstraint",
"description":"Indicates whether the field can be written to.",
"type":"boolean"
},
"hasUniquenessConstraint":{
"title":"hasUniquenessConstraint",
"description":"Indicates whether the field must have a unique value.",
"type":"boolean"
},
"internalName":{
"title":"internalName",
"description":"The field's internal name (used to uniquely identify it).",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the account definition.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"AccountList":{
"title":"AccountList",
"description":"The response body contains information about the account list definition.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the account definition.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"SyncActionOperation":{
"title":"SyncActionOperation",
"description":"The request body defines the details of the sync action definition. The following table displays properties for creating sync action definitions.",
"properties":{
"autoDeleteDuration":{
"title":"autoDeleteDuration",
"description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the sync action. This is a read-only property.",
"type":"string"
},
"fields":{
"title":"fields",
"description":"The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field.\r\n\r\nAllowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}.\r\n\r\nAllowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}.\r\n\r\nAllowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.",
"type":"object"
},
"identifierFieldName":{
"title":"identifierFieldName",
"description":"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.",
"type":"string"
},
"isSyncTriggeredOnImport":{
"title":"isSyncTriggeredOnImport",
"description":"Whether or not the sync is triggered upon uploading data.",
"type":"boolean"
},
"kbUsed":{
"format":"int64",
"title":"kbUsed",
"description":"The amount of space used in kb. This is a read-only property.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The name of the sync action definition.",
"type":"string"
},
"syncActions":{
"title":"syncActions",
"description":"Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. \r\nThere currently are not any sync actions available for Events.",
"type":"array",
"items":{
"$ref":"#/definitions/SyncAction"
}
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"EventRegistrationDataRest20":{
"title":"EventRegistrationData",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the event registrant. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"This property is not used for event registrants."
},
"name":{
"type":"string",
"description":"The name of the event registrant. This is a read-only property."
},
"description":{
"type":"string",
"description":"This property is not used for event registrants."
},
"permissions":{
"type":"array",
"description":"This property is not used for event registrants.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event registrants."
},
"sourceTemplateId":{
"type":"string",
"description":"This property is not used for event registrants."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event registrants."
},
"createdByName":{
"type":"string",
"description":"This property is not used for event registrants."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the event registrant was created, expressed in Unix time. This is a read-only property."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event registrants."
},
"updatedByName":{
"type":"string",
"description":"This property is not used for event registrants."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the event registrant was last updated. This is a read-only property."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event registrants."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event registrants."
},
"contactId":{
"type":"string",
"description":"The contact record Id associated to this event registrant. Use the desired contact's id as the value for this parameter."
},
"accountId":{
"type":"string",
"description":"The account record Id associated to this event registrant. This is a read-only property."
},
"uniqueCode":{
"type":"string",
"description":"The unique value associated to the event registrant. This is a read-only property."
},
"customObjectRecordStatus":{
"type":"string",
"description":"The status of the event registrant. Only returned when creating or updating an event registrant. This is a read-only property."
},
"fieldValues":{
"type":"array",
"description":"Array containing type, id, and value for all of the fields associated with a given event registrant.",
"items":{
"$ref":"#/definitions/FieldValueRest20"
}
},
"isMapped":{
"type":"string",
"description":"Whether or not the event registrant is mapped to a contact or account. This is a read-only property."
}
}
},
"QueryResultEventRegistrationDataRest20":{
"title":"QueryResultEventRegistrationData",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. "
},
"elements":{
"type":"array",
"description":"Array of event field elements.",
"items":{
"$ref":"#/definitions/EventRegistrationDataRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"FieldValueRest20":{
"title":"FieldValue",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"value":{
"type":"string",
"description":"The value to set the corresponding field id to. Date values must be submitted as a unix timestamp."
},
"id":{
"type":"string",
"readOnly":true,
"description":"The id of the field to be set to the corresponding value."
},
"name":{
"type":"string",
"description":"Name of the field value."
}
}
},
"FormDataRest10":{
"title":"FormData",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property"
},
"id":{
"type":"string",
"readOnly":true,
"description":"ID of the form submit if synchronous or ID of the form submission job if async. This is a read-only property"
},
"currentStatus":{
"type":"string",
"description":"Current status of form submission when submitted through asynchronous submission"
},
"submittedAt":{
"type":"string",
"description":"Unix timestamp for the date and time the form data was submitted. This is a read-only property"
},
"submittedByContactId":{
"type":"string",
"description":"ID of the contact that submitted the form. This is a read-only property"
},
"fieldValues":{
"type":"array",
"description":"A list of key/value pairs identifying the form data (field name / value)",
"items":{
"$ref":"#/definitions/FieldValueRest10"
}
},
"processingStepErrors":{
"type":"array",
"description":"A list of Processing Step Errors occurred in current form submission. This is a read-only property",
"items":{
"$ref":"#/definitions/ProcessingStepErrorRest10"
}
},
"processedAt":{
"type":"string",
"description":"Unix timestamp for the date and time the form data was processed if submitted through asynchronous submission. This is a read-only property"
},
"rowId":{
"type":"integer",
"description":"In case of asynchronous form submission if processed then submit ID of form submission. This is a read-only property"
},
"validationErrors":{
"type":"array",
"description":"Validation errors if any occured in form submission. This is a read-only property",
"items":{
"$ref":"#/definitions/ObjectValidationErrorRest10"
}
}
}
},
"QueryResultFormSubmissionRest10":{
"title":"QueryResultFormSubmission",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of form data elements.",
"items":{
"$ref":"#/definitions/FormDataRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"QueryResultAsyncFormSubmissionRest10":{
"title":"QueryResultAsyncFormSubmission",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of form submission data fields.",
"items":{
"$ref":"#/definitions/FormDataRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"ProcessingStepErrorRest10":{
"title":"ProcessingStepError",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"processingStepId":{
"type":"string",
"description":"Processing step id during which error ocurred"
},
"processingStepTypeId":{
"type":"string",
"description":"Type of the processing step during which error ocurred"
},
"processingStepDisplayName":{
"type":"string",
"description":"DisplayName of the processing step including description (if configured)"
},
"errorCode":{
"type":"integer",
"description":"Unique Error Code for current error"
},
"errorMessage":{
"type":"string",
"description":"Error message for current error code"
},
"errorDescription":{
"type":"string",
"description":"Detailed information about current error"
}
}
},
"ObjectValidationErrorRest10":{
"title":"ObjectValidationError",
"properties":{
"type":{
"type":"string"
},
"container":{
"$ref":"#/definitions/ObjectKeyRest10"
},
"property":{
"type":"string"
},
"value":{
"type":"string"
},
"requirement":{
"$ref":"#/definitions/RequirementRest10"
}
}
},
"ObjectKeyRest10":{
"title":"ObjectKey",
"properties":{
"type":{
"type":"string"
},
"objectType":{
"type":"string"
},
"objectId":{
"type":"string"
},
"container":{
"$ref":"#/definitions/ObjectKeyRest10"
}
}
},
"RequirementRest10":{
"title":"Requirement",
"properties":{
"type":{
"type":"string"
}
}
},
"ODataQueryOptions[Account]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"Account":{
"type":"object",
"properties":{
"accountId":{
"format":"int32",
"type":"integer"
},
"accountName":{
"type":"string"
},
"companyId":{
"format":"int32",
"type":"integer"
},
"accountSource":{
"format":"int32",
"type":"integer"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
},
"accountEngagement":{
"$ref":"#/definitions/AccountEngagement"
}
}
},
"AccountEngagement":{
"type":"object",
"properties":{
"accountId":{
"format":"int32",
"type":"integer"
},
"accountContacts":{
"format":"int32",
"type":"integer"
},
"engagementScore":{
"format":"double",
"type":"number"
},
"engagementScorePrev":{
"format":"double",
"type":"number"
},
"engagedContacts":{
"format":"int32",
"type":"integer"
},
"reachableContacts":{
"format":"int32",
"type":"integer"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
},
"account":{
"$ref":"#/definitions/Account"
}
}
},
"ODataQueryOptions[AccountEngagement]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"CustomObjectRest20":{
"title":"CustomObject",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the custom object."
},
"currentStatus":{
"type":"string",
"description":"This property is not used for custom objects."
},
"name":{
"type":"string",
"description":"The name of the custom object."
},
"description":{
"type":"string",
"description":"The description of the custom object."
},
"permissions":{
"type":"array",
"description":"The permissions for the custom object granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"This property is not used for custom objects."
},
"sourceTemplateId":{
"type":"string",
"description":"This property is not used for custom objects."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the custom object."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the custom object."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the custom object was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the custom object."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the custom object."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the custom object was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used for custom objects."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"fields":{
"type":"array",
"description":"Array consisting of custom object field properties.",
"items":{
"$ref":"#/definitions/CustomObjectFieldRest20"
}
},
"emailAddressFieldId":{
"type":"string",
"description":"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":{
"type":"string",
"description":"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":{
"type":"string",
"description":"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":{
"type":"string",
"description":"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 false. This feature is released under our Controlled Availability program. You can request access to this feature by submitting a request to My Oracle Support."
}
}
},
"QueryResultCustomObjectRest20":{
"title":"QueryResultCustomObject",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of custom object fields.",
"items":{
"$ref":"#/definitions/CustomObjectRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"CustomObjectFieldRest20":{
"title":"CustomObjectField",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"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":{
"type":"string",
"description":"This property is not used for custom object fields."
},
"description":{
"type":"string",
"description":"This property is not used for custom object fields."
},
"permissions":{
"type":"array",
"description":"This property is not used.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"This property is not used for custom object fields."
},
"sourceTemplateId":{
"type":"string",
"description":"This property is not used for custom object fields."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"This property is not used for custom object fields."
},
"createdByName":{
"type":"string",
"description":"This property is not used for custom object fields."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"This property is not used for custom object fields."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"This property is not used for custom object fields."
},
"updatedByName":{
"type":"string",
"description":"This property is not used for custom object fields."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"This property is not used for custom object fields."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used for custom object fields."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"name":{
"type":"string",
"description":"The name of the custom object field."
},
"displayType":{
"type":"string",
"description":"The custom object field's display type."
},
"dataType":{
"type":"string",
"description":"The custom object field's data type."
},
"defaultValue":{
"type":"string",
"description":"The custom object field's default value."
},
"internalName":{
"type":"string",
"description":"The custom object field's internal name. This is a read-only property."
},
"optionListId":{
"type":"string",
"description":"The option list id for a single select custom object field."
},
"checkedValue":{
"type":"string",
"description":"The checked value of a checkbox custom object field."
},
"uncheckedValue":{
"type":"string",
"description":"The unchecked value of a checkbox custom object field."
}
}
},
"QueryResultVisitorViewDataRest20":{
"title":"QueryResultVisitorViewData",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of visitor data.",
"items":{
"$ref":"#/definitions/Eloqua.API.REST.Contracts.Data.Visitors.VisitorViewDataRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"EntitySearchByExternalIdsRest20":{
"title":"EntitySearchByExternalIds",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. The default will be minimal. Learn more about the depth parameter."
},
"externalIds":{
"type":"array",
"description":"The external ids to retrieve. Maximum of 200 external ids per request. If the array exceeds the 200 limit, a 400 Bad Request will be returned.",
"items":{
"type":"string"
}
}
}
},
"Eloqua.API.REST.Contracts.Data.Visitors.VisitorViewDataRest20":{
"title":"Eloqua.API.REST.Contracts.Data.Visitors.VisitorViewData",
"properties":{
"type":{
"type":"string",
"description":"The visitor's type in Eloqua."
},
"visitorId":{
"type":"string",
"description":"The Id of the visitor profile."
},
"createdAt":{
"type":"string",
"description":"The date and time the visitor was created, expressed in Unix time."
},
"contactId":{
"type":"string",
"description":"The contact record Id associated to this profile, if any."
},
"id":{
"type":"integer",
"description":"The id of the visitor."
}
}
},
"EmailHeaderRest10":{
"title":"EmailHeader",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the email header. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The asset's current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"The name of the email header."
},
"description":{
"type":"string",
"description":"The description of the email header."
},
"permissions":{
"type":"string",
"description":"The permissions for the email header granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the email header."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the email header was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the email header."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the email header was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"body":{
"type":"string",
"description":"The email header's html text content."
},
"text":{
"type":"string",
"description":"The raw text from the \"body\" parameter."
},
"fieldMerges":{
"type":"array",
"description":"A list of associated Field Merges.",
"items":{
"$ref":"#/definitions/FieldMergeRest10"
}
},
"hyperlinks":{
"type":"array",
"description":"A list of hyperlinks contained within the asset.",
"items":{
"$ref":"#/definitions/HyperlinkRest10"
}
}
}
},
"QueryResultHeaderRest10":{
"title":"QueryResultHeader",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of header fields.",
"items":{
"$ref":"#/definitions/EmailHeaderRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"FieldMergeRest10":{
"title":"FieldMerge",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the field merge. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The field merge's current status."
},
"name":{
"type":"string",
"description":"Name of the field merge."
},
"description":{
"type":"string",
"description":"The description of the field merge."
},
"permissions":{
"type":"string",
"description":"The permissions for the field merge granted to your current instance."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the field merge."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the field merge was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the field merge."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the field merge was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"syntax":{
"type":"string",
"description":"The syntax of the field merge."
},
"defaultValue":{
"type":"string",
"description":"The default value of the field merge."
},
"contactFieldId":{
"type":"string",
"description":"Id of the associated contact field."
},
"accountFieldId":{
"type":"string",
"description":"Id of the associated account field."
},
"eventId":{
"type":"string",
"description":"Id of the associated event."
},
"eventFieldId":{
"type":"string",
"description":"Id of the associated event field."
},
"eventSessionFieldId":{
"type":"string",
"description":"Id of the associated event session field."
},
"mergeType":{
"type":"string",
"description":"Type of the field merge. Possible values include: contactField, accountField, eventField, eventSessionField, and customObjectField."
}
}
},
"EmailRest20":{
"title":"Email",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the email. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The asset's current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"The name of the email."
},
"description":{
"type":"string",
"description":"The description of the email."
},
"permissions":{
"type":"array",
"description":"The permissions for the email granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"Id of the folder."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the source template."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the email."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the email."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the email was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the email."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the email."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the email was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date and time the email is scheduled for."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"subject":{
"type":"string",
"description":"The email's subject line text."
},
"previewText":{
"type":"string",
"description":"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":{
"type":"string",
"description":"The sender name recipients of the email will see."
},
"senderEmail":{
"type":"string",
"description":"The address the email will appear to be sent from."
},
"replyToName":{
"type":"string",
"description":"The sender name recipients of the email will see."
},
"replyToEmail":{
"type":"string",
"description":"The email address targeted when recipients click \"reply\"."
},
"bounceBackEmail":{
"type":"string",
"description":"The email address which is notified if the email is undeliverable."
},
"virtualMTAId":{
"type":"string",
"description":"The numeric ID for the Virtual MTA configuration. Virtual MTAs are setup during the Branding and Deliverability package provisioning process. For more information, see the Oracle Eloqua Help Center."
},
"brandId":{
"type":"string",
"description":"The email's brand ID."
},
"htmlContent":{
"$ref":"#/definitions/HtmlContentRest20",
"description":"The email's content in HTML."
},
"plainText":{
"type":"string",
"description":"The email's content in plain text."
},
"isPlainTextEditable":{
"type":"string",
"description":"Whether or not the asset's text is editable."
},
"sendPlainTextOnly":{
"type":"string",
"description":"Whether or not the sent email is plain text only."
},
"isTracked":{
"type":"string",
"description":"Whether or not Eloqua will track the asset."
},
"isPrivate":{
"type":"string",
"description":"Whether or not the email is private."
},
"layout":{
"type":"string",
"description":"The email's main layout."
},
"style":{
"type":"string",
"description":"The email's main layout style."
},
"forms":{
"type":"array",
"description":"A list of associated Form assets.",
"items":{
"$ref":"#/definitions/FormRest20"
}
},
"images":{
"type":"array",
"description":"A list of associated Image assets.",
"items":{
"$ref":"#/definitions/ImageFileRest20"
}
},
"hyperlinks":{
"type":"array",
"description":"A list of hyperlinks contained within the email.",
"items":{
"$ref":"#/definitions/HyperlinkRest20"
}
},
"contentSections":{
"type":"array",
"description":"A list of content sections contained within the email.",
"items":{
"$ref":"#/definitions/ContentSectionRest20"
}
},
"dynamicContents":{
"type":"array",
"description":"A list of dynamic contents contained within the email.",
"items":{
"$ref":"#/definitions/DynamicContentRest20"
}
},
"files":{
"type":"array",
"description":"A list of imported files.",
"items":{
"$ref":"#/definitions/ImportedFileRest20"
}
},
"contentServiceInstances":{
"type":"array",
"description":"",
"items":{
"$ref":"#/definitions/CloudComponentInstanceRest20"
}
},
"emailHeaderId":{
"type":"string",
"description":"Id of the email header."
},
"emailFooterId":{
"type":"string",
"description":"Id of the email footer."
},
"emailGroupId":{
"type":"string",
"description":"Id of the email group."
},
"encodingId":{
"type":"string",
"description":"Id of the encoding used."
},
"fieldMerges":{
"type":"array",
"description":"A list of associated Field Merges.",
"items":{
"$ref":"#/definitions/FieldMergeRest20"
}
},
"attachments":{
"type":"array",
"description":"A list of imported files.",
"items":{
"$ref":"#/definitions/ImportedFileRest20"
}
},
"isContentProtected":{
"type":"string",
"description":"Whether or not the email is in protected mode."
},
"renderMode":{
"type":"string",
"description":"The layout of the email when it is sent or previewed. Possible values include: fixed or flow."
},
"archived":{
"type":"string",
"description":"Whether or not the email is archived."
},
"thumbnailUrl":{
"type":"string",
"description":"Email_Field_ThumbnailUrl_Description"
}
}
},
"QueryResultEmailRest20":{
"title":"QueryResultEmail",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of email data.",
"items":{
"$ref":"#/definitions/EmailRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"ArchiveParameterRest20":{
"title":"ArchiveParameter",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"targetFolderId":{
"type":"string",
"description":"The target folder to which the asset should be moved upon archive/unarchive. If not passed, the root folder will be used."
}
}
},
"ExternalAssetRest20":{
"title":"ExternalAsset",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the external asset. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The external asset's current status."
},
"description":{
"type":"string",
"description":"The description of the external asset."
},
"permissions":{
"type":"array",
"description":"The permissions for the external asset granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the external asset."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the external asset."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the external asset."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the external asset."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the external asset was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the external asset."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the external asset."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the external asset was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the external asset is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"externalAssetTypeId":{
"type":"string",
"description":"Id of the external asset type."
},
"name":{
"type":"string",
"description":"The name of the external asset."
}
}
},
"QueryResultExternalAssetRest20":{
"title":"QueryResultExternalAsset",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of external asset fields.",
"items":{
"$ref":"#/definitions/ExternalAssetRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"QueryResultActivityRest20":{
"title":"QueryResultActivity",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of Activity fields.",
"items":{
"$ref":"#/definitions/ActivityRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"ActivityRest20":{
"title":"Activity",
"properties":{
"type":{
"type":"string",
"description":"The type of activity."
},
"id":{
"type":"string",
"description":"The unique identifier of the activity per activity type, except for EmailSend"
},
"contactId":{
"type":"string",
"description":"The ID of the contact who performed the activity"
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time of the activity"
},
"assetId":{
"type":"string",
"description":"The ID of the asset associated with the activity"
},
"assetName":{
"type":"string",
"description":"The name of the asset associated with the activity"
},
"assetType":{
"type":"string",
"description":"The type of asset associated with the activity, such as email and form"
},
"isPending":{
"type":"string",
"description":"Activity_Field_IsPending_Description"
},
"fieldValues":{
"type":"array",
"description":"Array containing the details of the activity.",
"items":{
"type":"object",
"additionalProperties":{
"type":"string"
}
}
}
}
},
"Sync":{
"title":"Sync",
"description":"The definition of a sychronization. A synchronization is used to move data from the import staging area to the marketing database, or from the marketing database to the export staging area.",
"properties":{
"callbackUrl":{
"title":"callbackUrl",
"description":"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.",
"type":"string"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"status":{
"$ref":"#/definitions/SyncStatusType"
},
"syncedInstanceUri":{
"title":"syncedInstanceUri",
"description":"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.",
"type":"string"
},
"syncEndedAt":{
"format":"date-time",
"title":"syncEndedAt",
"description":"The date and time the sync ended. This is a read-only property.",
"type":"string"
},
"syncStartedAt":{
"format":"date-time",
"title":"syncStartedAt",
"description":"The date and time the sync started. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"SyncLog":{
"title":"SyncLog",
"description":"The detailed information about the sychronization.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"message":{
"title":"message",
"description":"The status message.",
"type":"string"
},
"severity":{
"$ref":"#/definitions/SyncResultSeverity"
},
"statusCode":{
"title":"statusCode",
"description":"The Eloqua status code.",
"type":"string"
},
"syncUri":{
"title":"syncUri",
"description":"The sync's uri address.",
"type":"string"
}
}
},
"SyncResultSeverity":{
"title":"SyncResultSeverity",
"description":"The severity of the sync result.",
"default":"information",
"enum":[
"information",
"warning",
"error"
],
"type":"string"
},
"SyncReject":{
"title":"SyncReject",
"description":"The detailed information about the import sychronization data.",
"properties":{
"fieldValues":{
"title":"fieldValues",
"description":"The sync's field values.",
"type":"object"
},
"invalidFields":{
"title":"invalidFields",
"description":"The sync's invalid fields.",
"type":"array",
"items":{
"type":"string"
}
},
"message":{
"title":"message",
"description":"The sync's message.",
"type":"string"
},
"recordIndex":{
"title":"recordIndex",
"description":"The sync's record index.",
"type":"integer"
},
"statusCode":{
"title":"statusCode",
"description":"The Eloqua status code.",
"type":"string"
}
}
},
"EmailRest10":{
"title":"Email",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the email. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The asset's current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"The name of the email."
},
"description":{
"type":"string",
"description":"The description of the email."
},
"permissions":{
"type":"string",
"description":"The permissions for the email granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the email."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the email was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the email."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the email was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"subject":{
"type":"string",
"description":"The email's subject line text."
},
"senderName":{
"type":"string",
"description":"The sender name recipients of the email will see."
},
"senderEmail":{
"type":"string",
"description":"The address the email will appear to be sent from."
},
"replyToName":{
"type":"string",
"description":"The sender name recipients of the email will see."
},
"replyToEmail":{
"type":"string",
"description":"The email address targeted when recipients click \"reply\"."
},
"bounceBackEmail":{
"type":"string",
"description":"The email address which is notified if the email is undeliverable."
},
"virtualMTAId":{
"type":"string",
"description":"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. Learn more."
},
"brandId":{
"type":"string",
"description":"The email's brand ID."
},
"htmlContent":{
"$ref":"#/definitions/HtmlContentRest10",
"description":"The email's raw html content."
},
"plainText":{
"type":"string",
"description":"The email's content in plain text."
},
"isPlainTextEditable":{
"type":"string",
"description":"Whether or not the asset's text is editable."
},
"sendPlainTextOnly":{
"type":"string",
"description":"Whether or not the sent email is plain text only."
},
"isTracked":{
"type":"string",
"description":"Whether or not Eloqua will track the asset."
},
"layout":{
"type":"string",
"description":"The email's main layout."
},
"style":{
"type":"string",
"description":"The email's main layout style."
},
"forms":{
"type":"array",
"description":"A list of associated Form assets.",
"items":{
"$ref":"#/definitions/FormRest10"
}
},
"images":{
"type":"array",
"description":"A list of associated Image assets.",
"items":{
"$ref":"#/definitions/ImageFileRest10"
}
},
"hyperlinks":{
"type":"array",
"description":"A list of hyperlinks contained within the email.",
"items":{
"$ref":"#/definitions/HyperlinkRest10"
}
},
"contentSections":{
"type":"array",
"description":"A list of associated Content Section assets.",
"items":{
"$ref":"#/definitions/ContentSectionRest10"
}
},
"dynamicContents":{
"type":"array",
"description":"A list of associated dynamic content.",
"items":{
"$ref":"#/definitions/DynamicContentRest10"
}
},
"landingPages":{
"type":"array",
"description":"A list of associated landing page assets.",
"items":{
"$ref":"#/definitions/LandingPageRest10"
}
},
"files":{
"type":"array",
"description":"A list of imported files.",
"items":{
"$ref":"#/definitions/ImportedFileRest10"
}
},
"emailHeaderId":{
"type":"string",
"description":"Id of the email header."
},
"emailFooterId":{
"type":"string",
"description":"Id of the email footer."
},
"emailGroupId":{
"type":"string",
"description":"Id of the email group."
},
"encodingId":{
"type":"string",
"description":"Id of the encoding used."
},
"fieldMerges":{
"type":"array",
"description":"A list of associated Field Merges.",
"items":{
"$ref":"#/definitions/FieldMergeRest10"
}
}
}
},
"QueryResultEmailRest10":{
"title":"QueryResultEmail",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of email fields.",
"items":{
"$ref":"#/definitions/EmailRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"CampaignFieldRest20":{
"title":"CampaignField",
"properties":{
"type":{
"type":"string",
"description":"CampaignField_Field_Type_Description"
},
"id":{
"type":"string",
"readOnly":true,
"description":"CampaignField_Field_InternalId_Description"
},
"currentStatus":{
"type":"string",
"description":"CampaignField_Field_Status_Description"
},
"name":{
"type":"string",
"description":"CampaignField_Field_Name_Description"
},
"description":{
"type":"string",
"description":"CampaignField_Field_Description_Description"
},
"permissions":{
"type":"array",
"description":"CampaignField_Field_Permissions_Description",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"CampaignField_Field_FolderId_Description"
},
"sourceTemplateId":{
"type":"string",
"description":"CampaignField_Field_SourceTemplateId_Description"
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"CampaignField_Field_CreatedBy_Description"
},
"createdByName":{
"type":"string",
"description":"CampaignField_Field_CreatedByName_Description"
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"CampaignField_Field_CreatedAt_Description"
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"CampaignField_Field_UpdatedBy_Description"
},
"updatedByName":{
"type":"string",
"description":"CampaignField_Field_UpdatedByName_Description"
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"CampaignField_Field_UpdatedAt_Description"
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"CampaignField_Field_ScheduledFor_Description"
},
"depth":{
"type":"string",
"readOnly":true,
"description":"CampaignField_Field_InternalDepth_Description"
},
"displayType":{
"type":"string",
"description":"The campaign field's display type. The options are: multiSelect, singleSelect, and text."
},
"dataType":{
"type":"string",
"description":"The campaign field's data type. The options are: date, numeric, and text."
},
"isRequired":{
"type":"string",
"description":"Whether or not the campaign field is required."
},
"isReadOnly":{
"type":"string",
"description":"Whether or not the campaign field is read only."
},
"optionListId":{
"type":"string",
"description":"The id of the associated option list."
},
"isSystem":{
"type":"string",
"description":"Whether or not the campaign field is a system field."
},
"displayIndex":{
"type":"string",
"description":"The campaign field's display index."
}
}
},
"QueryResultCampaignFieldRest20":{
"title":"QueryResultCampaignField",
"properties":{
"type":{
"type":"string",
"description":"QueryResult1CampaignField_Field_Type_Description"
},
"elements":{
"type":"array",
"description":"QueryResult1CampaignField_Field_Elements_Description",
"items":{
"$ref":"#/definitions/CampaignFieldRest20"
}
},
"total":{
"type":"integer",
"description":"QueryResult1CampaignField_Field_TotalElements_Description"
},
"pageSize":{
"type":"integer",
"description":"QueryResult1CampaignField_Field_PageSize_Description"
},
"page":{
"type":"integer",
"description":"QueryResult1CampaignField_Field_PageIndex_Description"
}
}
},
"ODataQueryOptions[Campaign]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"Campaign":{
"type":"object",
"properties":{
"eloquaCampaignId":{
"format":"int32",
"type":"integer"
},
"campaignName":{
"type":"string"
},
"crmCampaignId":{
"type":"string"
},
"campaignDescription":{
"type":"string"
},
"campaignCreatedDateTime":{
"format":"date-time",
"type":"string"
},
"campaignProduct":{
"type":"string"
},
"campaignRegion":{
"type":"string"
},
"campaignType":{
"type":"string"
},
"campaignStatus":{
"type":"string"
},
"isDeleted":{
"type":"boolean"
},
"campaignStartDate":{
"format":"date-time",
"type":"string"
},
"campaignEndDate":{
"format":"date-time",
"type":"string"
},
"campaignCreatedByUserId":{
"format":"int32",
"type":"integer"
},
"lastActivatedByUserId":{
"format":"int32",
"type":"integer"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
},
"campaignClassification":{
"type":"string"
},
"adCampaignId":{
"type":"string"
},
"referenceProduct":{
"type":"string"
},
"actualCost":{
"format":"double",
"type":"number"
},
"budgetedCost":{
"format":"double",
"type":"number"
}
}
},
"ODataQueryOptions[CampaignResponse]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"CampaignResponse":{
"type":"object",
"properties":{
"campaignResponseID":{
"format":"int32",
"type":"integer"
},
"eloquaCampaignID":{
"format":"int32",
"type":"integer"
},
"contactID":{
"format":"int32",
"type":"integer"
},
"responseDateHour":{
"format":"date-time",
"type":"string"
},
"totalNewLeads":{
"format":"int32",
"type":"integer"
},
"totalResponses":{
"format":"int32",
"type":"integer"
}
}
},
"ODataQueryOptions[Contact]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"Contact":{
"type":"object",
"properties":{
"contactId":{
"format":"int32",
"type":"integer"
},
"createdDate":{
"format":"date-time",
"type":"string"
},
"createdDateHour":{
"format":"date-time",
"type":"string"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
},
"firstName":{
"type":"string"
},
"lastName":{
"type":"string"
},
"company":{
"type":"string"
},
"emailAddress":{
"type":"string"
},
"emailAddressDomain":{
"type":"string"
},
"contactAddress1":{
"type":"string"
},
"contactAddress2":{
"type":"string"
},
"contactAddress3":{
"type":"string"
},
"contactCity":{
"type":"string"
},
"contactStateProv":{
"type":"string"
},
"contactZipPostalCode":{
"type":"string"
},
"contactCountry":{
"type":"string"
},
"businessPhone":{
"type":"string"
},
"salesPerson":{
"type":"string"
},
"mobilePhone":{
"type":"string"
},
"fax":{
"type":"string"
},
"title":{
"type":"string"
},
"leadSourceMostRecent":{
"type":"string"
},
"leadSourceOriginal":{
"type":"string"
},
"territory":{
"type":"string"
},
"accountID":{
"format":"int32",
"type":"integer"
},
"eloquaLinkedAccountId":{
"format":"int32",
"type":"integer"
}
}
},
"ODataQueryOptions[ContactIntegrationFields]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"ContactIntegrationFields":{
"type":"object",
"properties":{
"contactId":{
"format":"int32",
"type":"integer"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
},
"lastSFDCCampaignID":{
"type":"string"
},
"lastSFDCCampaignName":{
"type":"string"
},
"lastSFDCCampaignStatus":{
"type":"string"
},
"sfdcContactID":{
"type":"string"
},
"sfdcAccountID":{
"type":"string"
},
"sfdcEmailOptOut":{
"type":"string"
},
"sfdcLeadID":{
"type":"string"
},
"sfdcLeadRating":{
"type":"string"
},
"oracleSalesCloudAccountID":{
"type":"string"
},
"oracleSalesCloudContactID":{
"type":"string"
},
"oracleSalesCloudLeadID":{
"type":"string"
},
"lastMSCRMCampaignID":{
"type":"string"
},
"lastMSCRMCampaignName":{
"type":"string"
},
"lastMSCRMCampaignResponseID":{
"type":"string"
},
"lastMSCRMCampaignStatus":{
"type":"string"
},
"mscrmAccountID":{
"type":"string"
},
"mscrmContactID":{
"type":"string"
},
"mscrmEmailOptOut":{
"type":"string"
},
"mscrmLeadID":{
"type":"string"
},
"mscrmLeadRating":{
"type":"string"
}
}
},
"ODataQueryOptions[Device]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"Device":{
"type":"object",
"properties":{
"deviceID":{
"format":"int32",
"type":"integer"
},
"brandName":{
"type":"string"
},
"browser":{
"type":"string"
},
"browserMajorVersion":{
"format":"int32",
"type":"integer"
},
"browserMinorVersion":{
"format":"int32",
"type":"integer"
},
"deviceCategory":{
"type":"string"
},
"formFactor":{
"type":"string"
},
"marketingName":{
"type":"string"
},
"modelName":{
"type":"string"
},
"os":{
"type":"string"
},
"osMajorVersion":{
"format":"int32",
"type":"integer"
},
"osMinorVersion":{
"format":"int32",
"type":"integer"
}
}
},
"ODataQueryOptions[EloquaLinkedAccount]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"EloquaLinkedAccount":{
"type":"object",
"properties":{
"eloquaLinkedAccountId":{
"format":"int32",
"type":"integer"
},
"accountName":{
"type":"string"
},
"accountBusinessPhone":{
"type":"string"
},
"accountAddress1":{
"type":"string"
},
"accountAddress2":{
"type":"string"
},
"accountAddress3":{
"type":"string"
},
"accountCity":{
"type":"string"
},
"accountStateProvince":{
"type":"string"
},
"accountCountry":{
"type":"string"
},
"accountZipPostCode":{
"type":"string"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
},
"createdDate":{
"format":"date-time",
"type":"string"
}
}
},
"ODataQueryOptions[EmailAsset]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"EmailAsset":{
"type":"object",
"properties":{
"emailID":{
"format":"int32",
"type":"integer"
},
"emailName":{
"type":"string"
},
"subjectLine":{
"type":"string"
},
"emailGroupID":{
"format":"int32",
"type":"integer"
},
"emailGroup":{
"type":"string"
},
"emailGroupDescription":{
"type":"string"
},
"emailGroupIsDeleted":{
"type":"boolean"
},
"isDeleted":{
"type":"boolean"
},
"isArchived":{
"type":"boolean"
},
"emailCreatedByUserID":{
"format":"int32",
"type":"integer"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
}
}
},
"ODataQueryOptions[EmailAutoClick]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"EmailAutoClick":{
"type":"object",
"properties":{
"emailAutoClickID":{
"format":"int32",
"type":"integer"
},
"eloquaCampaignID":{
"format":"int32",
"type":"integer"
},
"accountID":{
"format":"int32",
"type":"integer"
},
"contactID":{
"format":"int32",
"type":"integer"
},
"eloquaLinkedAccountID":{
"format":"int32",
"type":"integer"
},
"emailID":{
"format":"int32",
"type":"integer"
},
"segmentID":{
"format":"int32",
"type":"integer"
},
"sentDateHour":{
"format":"date-time",
"type":"string"
},
"firstClick":{
"format":"int32",
"type":"integer"
},
"clickDateHour":{
"format":"date-time",
"type":"string"
},
"baseUrlId":{
"format":"int32",
"type":"integer"
},
"contact":{
"$ref":"#/definitions/Contact"
}
}
},
"ODataQueryOptions[EmailAutoOpen]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"EmailAutoOpen":{
"type":"object",
"properties":{
"emailAutoOpenID":{
"format":"int64",
"type":"integer"
},
"eloquaCampaignID":{
"format":"int32",
"type":"integer"
},
"accountID":{
"format":"int32",
"type":"integer"
},
"contactID":{
"format":"int32",
"type":"integer"
},
"eloquaLinkedAccountID":{
"format":"int32",
"type":"integer"
},
"emailID":{
"format":"int32",
"type":"integer"
},
"segmentID":{
"format":"int32",
"type":"integer"
},
"sentDateHour":{
"format":"date-time",
"type":"string"
},
"firstOpen":{
"format":"int32",
"type":"integer"
},
"openDateHour":{
"format":"date-time",
"type":"string"
},
"deviceInfoId":{
"format":"int32",
"type":"integer"
},
"contact":{
"$ref":"#/definitions/Contact"
}
}
},
"ODataQueryOptions[EmailBounceback]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"EmailBounceback":{
"type":"object",
"properties":{
"emailBouncebackId":{
"format":"int32",
"type":"integer"
},
"eloquaCampaignID":{
"format":"int32",
"type":"integer"
},
"accountID":{
"format":"int32",
"type":"integer"
},
"contactID":{
"format":"int32",
"type":"integer"
},
"eloquaLinkedAccountID":{
"format":"int32",
"type":"integer"
},
"emailID":{
"format":"int32",
"type":"integer"
},
"segmentID":{
"format":"int32",
"type":"integer"
},
"sentDateHour":{
"format":"date-time",
"type":"string"
},
"emailSendId":{
"format":"int64",
"type":"integer"
},
"bounceBackDateHour":{
"format":"date-time",
"type":"string"
},
"firstBounceback":{
"format":"int32",
"type":"integer"
},
"isHardBounceback":{
"type":"boolean"
},
"smtpReplyCode":{
"type":"string"
},
"smtpErrorCode":{
"type":"string"
},
"bounceBackMessage":{
"type":"string"
},
"bouncebackFromAddress":{
"type":"string"
},
"contact":{
"$ref":"#/definitions/Contact"
}
}
},
"ODataQueryOptions[EmailClickthrough]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"EmailClickthrough":{
"type":"object",
"properties":{
"emailClickthroughId":{
"format":"int32",
"type":"integer"
},
"eloquaCampaignID":{
"format":"int32",
"type":"integer"
},
"accountID":{
"format":"int32",
"type":"integer"
},
"contactID":{
"format":"int32",
"type":"integer"
},
"eloquaLinkedAccountID":{
"format":"int32",
"type":"integer"
},
"emailID":{
"format":"int32",
"type":"integer"
},
"segmentID":{
"format":"int32",
"type":"integer"
},
"sentDateHour":{
"format":"date-time",
"type":"string"
},
"baseUrlId":{
"format":"int32",
"type":"integer"
},
"clickDateHour":{
"format":"date-time",
"type":"string"
},
"firstClick":{
"format":"int32",
"type":"integer"
},
"clickThroughLink":{
"type":"string"
},
"clickthroughQueryStringValue":{
"type":"string"
},
"contact":{
"$ref":"#/definitions/Contact"
}
}
},
"ODataQueryOptions[EmailGrp]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"EmailGrp":{
"type":"object",
"properties":{
"emailGroupID":{
"format":"int32",
"type":"integer"
},
"emailGroup":{
"type":"string"
},
"emailGroupDescription":{
"type":"string"
},
"isDeleted":{
"type":"boolean"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
}
}
},
"ODataQueryOptions[EmailGroupSubscriptionStatus]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"EmailGroupSubscriptionStatus":{
"type":"object",
"properties":{
"emailGroupID":{
"format":"int32",
"type":"integer"
},
"contactID":{
"format":"int32",
"type":"integer"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
},
"isSubscribed":{
"type":"boolean"
},
"contact":{
"$ref":"#/definitions/Contact"
}
}
},
"ODataQueryOptions[EmailOpen]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"EmailOpen":{
"type":"object",
"properties":{
"emailOpenID":{
"format":"int64",
"type":"integer"
},
"eloquaCampaignID":{
"format":"int32",
"type":"integer"
},
"accountID":{
"format":"int32",
"type":"integer"
},
"contactID":{
"format":"int32",
"type":"integer"
},
"eloquaLinkedAccountID":{
"format":"int32",
"type":"integer"
},
"emailID":{
"format":"int32",
"type":"integer"
},
"segmentID":{
"format":"int32",
"type":"integer"
},
"openDateHour":{
"format":"date-time",
"type":"string"
},
"sentDateHour":{
"format":"date-time",
"type":"string"
},
"firstOpen":{
"format":"int32",
"type":"integer"
},
"deviceInfoId":{
"format":"int32",
"type":"integer"
},
"contact":{
"$ref":"#/definitions/Contact"
}
}
},
"ODataQueryOptions[EmailSend]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"EmailSend":{
"type":"object",
"properties":{
"emailSendID":{
"format":"int64",
"type":"integer"
},
"eloquaCampaignID":{
"format":"int32",
"type":"integer"
},
"accountID":{
"format":"int32",
"type":"integer"
},
"contactID":{
"format":"int32",
"type":"integer"
},
"eloquaLinkedAccountID":{
"format":"int32",
"type":"integer"
},
"emailID":{
"format":"int32",
"type":"integer"
},
"segmentID":{
"format":"int32",
"type":"integer"
},
"sentDateHour":{
"format":"date-time",
"type":"string"
}
}
},
"ODataQueryOptions[EmailUnsubscribe]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"EmailUnsubscribe":{
"type":"object",
"properties":{
"emailUnsubscriptionId":{
"format":"int32",
"type":"integer"
},
"eloquaCampaignID":{
"format":"int32",
"type":"integer"
},
"accountID":{
"format":"int32",
"type":"integer"
},
"contactID":{
"format":"int32",
"type":"integer"
},
"eloquaLinkedAccountID":{
"format":"int32",
"type":"integer"
},
"emailID":{
"format":"int32",
"type":"integer"
},
"segmentID":{
"format":"int32",
"type":"integer"
},
"sentDateHour":{
"format":"date-time",
"type":"string"
},
"unsubscribedDateHour":{
"format":"date-time",
"type":"string"
},
"contact":{
"$ref":"#/definitions/Contact"
}
}
},
"ODataQueryOptions[FormSubmission]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"FormSubmission":{
"type":"object",
"properties":{
"formSubmitId":{
"format":"int32",
"type":"integer"
},
"eloquaCampaignID":{
"format":"int32",
"type":"integer"
},
"accountID":{
"format":"int32",
"type":"integer"
},
"contactID":{
"format":"int32",
"type":"integer"
},
"eloquaLinkedAccountID":{
"format":"int32",
"type":"integer"
},
"emailID":{
"format":"int32",
"type":"integer"
},
"segmentID":{
"format":"int32",
"type":"integer"
},
"sentDateHour":{
"format":"date-time",
"type":"string"
},
"landingPageId":{
"format":"int32",
"type":"integer"
},
"formSubmitDateHour":{
"format":"date-time",
"type":"string"
},
"formId":{
"format":"int32",
"type":"integer"
},
"contact":{
"$ref":"#/definitions/Contact"
}
}
},
"ODataQueryOptions[LandingPageVisit]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"LandingPageVisit":{
"type":"object",
"properties":{
"landingPageViewID":{
"format":"int64",
"type":"integer"
},
"landingPageViewDateHour":{
"format":"date-time",
"type":"string"
},
"campaignID":{
"format":"int32",
"type":"integer"
},
"baseURLID":{
"format":"int32",
"type":"integer"
},
"landingPageID":{
"format":"int32",
"type":"integer"
},
"visitorID":{
"format":"int64",
"type":"integer"
},
"sessionID":{
"format":"int64",
"type":"integer"
},
"referrerID":{
"format":"int32",
"type":"integer"
},
"landingPageTime":{
"format":"int32",
"type":"integer"
},
"contactID":{
"format":"int32",
"type":"integer"
},
"accountID":{
"format":"int32",
"type":"integer"
},
"eloquaLinkedAccountID":{
"format":"int32",
"type":"integer"
}
}
},
"ODataQueryOptions[Referrer]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"Referrer":{
"type":"object",
"properties":{
"referrerID":{
"format":"int32",
"type":"integer"
},
"sourceType":{
"type":"string"
},
"sourceName":{
"type":"string"
},
"referrerDomain":{
"type":"string"
},
"referrerURL":{
"type":"string"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
}
}
},
"ODataQueryOptions[Segment]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"Segment":{
"type":"object",
"properties":{
"segmentId":{
"format":"int32",
"type":"integer"
},
"segment":{
"type":"string"
},
"segmentDescription":{
"type":"string"
},
"segmentCreatedByUserId":{
"format":"int32",
"type":"integer"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
}
}
},
"ODataQueryOptions[SpamUnsubscribesByEmail]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"SpamUnsubscribesByEmail":{
"type":"object",
"properties":{
"emailUnsubscriptionId":{
"format":"int32",
"type":"integer"
},
"eloquaCampaignID":{
"format":"int32",
"type":"integer"
},
"accountID":{
"format":"int32",
"type":"integer"
},
"contactID":{
"format":"int32",
"type":"integer"
},
"eloquaLinkedAccountID":{
"format":"int32",
"type":"integer"
},
"emailID":{
"format":"int32",
"type":"integer"
},
"segmentID":{
"format":"int32",
"type":"integer"
},
"sentDateHour":{
"format":"date-time",
"type":"string"
},
"spamUnsubscribedDateHour":{
"format":"date-time",
"type":"string"
},
"contact":{
"$ref":"#/definitions/Contact"
}
}
},
"ODataQueryOptions[User]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"User":{
"type":"object",
"properties":{
"userID":{
"format":"int32",
"type":"integer"
},
"userName":{
"type":"string"
},
"userEmailAddress":{
"type":"string"
},
"lastModifiedDateTime":{
"format":"date-time",
"type":"string"
},
"isDeleted":{
"type":"boolean"
}
}
},
"EventRegistrationRest20":{
"title":"EventRegistration",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the event. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"This property is not used for events."
},
"name":{
"type":"string",
"description":"The name of the event."
},
"description":{
"type":"string",
"description":"The description of the event."
},
"permissions":{
"type":"array",
"description":"This property is not used for events.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the event."
},
"sourceTemplateId":{
"type":"string",
"description":"This property is not used for events."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the event. This is a read-only property."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the event."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the event was created, expressed in Unix time. This is a read-only property."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the event. This is a read-only property."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the event."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the event was last updated. This is a read-only property."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used for events."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"fields":{
"type":"array",
"description":"Array consisting of event field properties.",
"items":{
"$ref":"#/definitions/CustomObjectFieldRest20"
}
},
"sessions":{
"type":"array",
"description":"Array consisting of event sessions.",
"items":{
"$ref":"#/definitions/EventSessionRest20"
}
},
"sessionFields":{
"type":"array",
"description":"Array consisting of session fields within a session.",
"items":{
"$ref":"#/definitions/EventSessionFieldRest20"
}
},
"sessionFieldValues":{
"type":"array",
"description":"Array consisting of session fields values for a session. You must create session fields and session before creating the session field values.",
"items":{
"$ref":"#/definitions/EventSessionFieldValueRest20"
}
},
"emailAddressFieldId":{
"type":"string",
"description":"The field id that contains the Email Address. Use the desired custom object field's negative id as the value for this parameter."
},
"uniqueCodeFieldId":{
"type":"string",
"description":"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":{
"type":"string",
"description":"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."
}
}
},
"QueryResultEventRegistrationRest20":{
"title":"QueryResultEventRegistration",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. "
},
"elements":{
"type":"array",
"description":"Array of event field elements.",
"items":{
"$ref":"#/definitions/EventRegistrationRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"EventSessionRest20":{
"title":"EventSession",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the event session. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"This property is not used for event sessions."
},
"name":{
"type":"string",
"description":"The name of the session."
},
"description":{
"type":"string",
"description":"This property is not used for event sessions."
},
"permissions":{
"type":"array",
"description":"This property is not used.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event sessions."
},
"sourceTemplateId":{
"type":"string",
"description":"This property is not used for event sessions."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event sessions."
},
"createdByName":{
"type":"string",
"description":"This property is not used for event sessions."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event sessions."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event sessions."
},
"updatedByName":{
"type":"string",
"description":"This property is not used for event sessions."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event sessions."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event sessions."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event sessions."
},
"participantsLimit":{
"type":"integer",
"description":"The maximum number of participants per session."
}
}
},
"EventSessionFieldRest20":{
"title":"EventSessionField",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the event session field. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"This property is not used for event session fields."
},
"name":{
"type":"string",
"description":"The name of the session field within an event."
},
"description":{
"type":"string",
"description":"This property is not used for event session fields."
},
"permissions":{
"type":"array",
"description":"This property is not used.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event session fields."
},
"sourceTemplateId":{
"type":"string",
"description":"This property is not used for event session fields."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event session fields."
},
"createdByName":{
"type":"string",
"description":"This property is not used for event session fields."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event session fields."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event session fields."
},
"updatedByName":{
"type":"string",
"description":"This property is not used for event session fields."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event session fields."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event session fields."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event session fields."
},
"dataType":{
"type":"string",
"description":"The DataType of the session field."
},
"outputFormat":{
"$ref":"#/definitions/FieldOutputFormatRest20",
"description":"The output format for number, date / time, and numeric custom object fields. Only the display format???s id is required. See list of default display formats here. If using custom display formats, these should be set in Eloqua."
}
}
},
"EventSessionFieldValueRest20":{
"title":"EventSessionFieldValue",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"id":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event session field values."
},
"currentStatus":{
"type":"string",
"description":"This property is not used for event session field values."
},
"name":{
"type":"string",
"description":"This property is not used for event session field values."
},
"description":{
"type":"string",
"description":"This property is not used for event session field values."
},
"permissions":{
"type":"array",
"description":"This property is not used.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event session field values."
},
"sourceTemplateId":{
"type":"string",
"description":"This property is not used for event session field values."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event session field values."
},
"createdByName":{
"type":"string",
"description":"This property is not used for event session field values."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event session field values."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event session field values."
},
"updatedByName":{
"type":"string",
"description":"This property is not used for event session field values."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event session field values."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event session field values."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"This property is not used for event session field values."
},
"sessionId":{
"type":"string",
"description":"The SessionId of the session within an event for which field value is passed."
},
"sessionFieldId":{
"type":"string",
"description":"The SessionFieldId of the field. The session field must be created first before creating session field values."
},
"value":{
"type":"string",
"description":"The value for the event session field."
}
}
},
"FieldOutputFormatRest20":{
"title":"FieldOutputFormat",
"properties":{
"type":{
"type":"string"
},
"currentStatus":{
"type":"string"
},
"id":{
"type":"string"
},
"format":{
"type":"string"
},
"dataType":{
"type":"string"
}
}
},
"ExternalAssetTypeRest20":{
"title":"ExternalAssetType",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the external asset type."
},
"currentStatus":{
"type":"string",
"description":"The external asset type's current status."
},
"description":{
"type":"string",
"description":"The description of the external asset type."
},
"permissions":{
"type":"array",
"description":"The permissions for the external asset type granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the external asset type."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the external asset type."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the external asset type."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the external asset type."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the external asset type was created, expressed in Unix time. "
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the external asset type."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the external asset type."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the external asset type was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the external asset type is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"activityTypes":{
"type":"array",
"description":"A list of the external activity types associated with the external asset type.",
"items":{
"$ref":"#/definitions/ExternalActivityTypeRest20"
}
},
"name":{
"type":"string",
"description":"The name of the external asset type."
},
"image":{
"$ref":"#/definitions/ImageFileRest20",
"description":"A list of associated Image assets."
}
}
},
"QueryResultExternalAssetTypeRest20":{
"title":"QueryResultExternalAssetType",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of account group fields.",
"items":{
"$ref":"#/definitions/ExternalAssetTypeRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"ExternalActivityTypeRest20":{
"title":"ExternalActivityType",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the external activity type."
},
"currentStatus":{
"type":"string",
"description":"The external activity type's current status."
},
"description":{
"type":"string",
"description":"The description of the external activity type."
},
"permissions":{
"type":"array",
"description":"The permissions for the external activity type granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the external activity type."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the external activity type."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the external activity type."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the external activity type."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the external activity type was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the external activity type."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the external activity type."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the external activity type was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the external activity type is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"name":{
"type":"string",
"description":"The name of the external activity type."
}
}
},
"FolderRest10":{
"title":"Folder",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the email folder. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The email folder's current status."
},
"name":{
"type":"string",
"description":"The name of the email folder."
},
"description":{
"type":"string",
"description":"The description of the email folder."
},
"permissions":{
"type":"string",
"description":"The permissions for the email folder granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the email folder."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the email folder was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the email folder."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the email folder was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"isSystem":{
"type":"string",
"readOnly":true,
"description":"Whether or not the email folder is a system folder."
}
}
},
"QueryResultFolderRest10":{
"title":"QueryResultFolder",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of folder fields.",
"items":{
"$ref":"#/definitions/FolderRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"EmailDeploymentRest20":{
"title":"EmailDeployment",
"properties":{
"type":{
"type":"string",
"description":"The type of email deployment. Possible values include: \r\n\r\nEmailTestDeploymentEmailLowVolumeDeployment
\r\n\r\nNote that the activity's Email Send Type will appear as QuickSend."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Unique identifier of the email deployment."
},
"currentStatus":{
"type":"string",
"description":"Current deployment status. Possible values are: normal, locked, forceComplete, inError, or resend."
},
"name":{
"type":"string",
"description":"The name of the deployment."
},
"description":{
"type":"string",
"description":"Description of the deployment."
},
"permissions":{
"type":"array",
"description":"Permission values of the deployment granted to the current user.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"Id of the folder."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the source template."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the email deployment."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the email deployment."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the email deployment was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the email deployment."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the email deployment."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the email deployment was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date and time the email deployment is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"The request's level of detail."
},
"email":{
"$ref":"#/definitions/EmailRest20",
"description":"Information about the email asset. Email properties cannot be modified via this endpoint."
},
"successfulSendCount":{
"type":"string",
"readOnly":true,
"description":"The number of emails which have been successfully sent so far."
},
"failedSendCount":{
"type":"string",
"readOnly":true,
"description":"The number of emails which failed during send so far."
},
"endAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the email deployment ended."
},
"sentContent":{
"type":"string",
"description":"The content type of the email."
},
"sentSubject":{
"type":"string",
"description":"The subject line of the email."
},
"sendDate":{
"type":"string",
"description":"EmailDeployment_Field_SendDate_Description"
}
}
},
"ContactField":{
"title":"ContactField",
"description":"The definition of a field on all contacts in the system.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataType":{
"$ref":"#/definitions/DataType"
},
"defaultValue":{
"title":"defaultValue",
"description":"The contact field's default value.",
"type":"string"
},
"hasNotNullConstraint":{
"title":"hasNotNullConstraint",
"description":"Indicates whether the field can have null values (i.e. empty).",
"type":"boolean"
},
"hasReadOnlyConstraint":{
"title":"hasReadOnlyConstraint",
"description":"Indicates whether the field can be written to.",
"type":"boolean"
},
"hasUniquenessConstraint":{
"title":"hasUniquenessConstraint",
"description":"Indicates whether the field must have a unique value.",
"type":"boolean"
},
"internalName":{
"title":"internalName",
"description":"The field's internal name (used to uniquely identify it).",
"type":"string"
},
"name":{
"title":"name",
"description":"The contact field's name.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"ContactFilter":{
"title":"ContactFilter",
"description":"The definition of a dynamic list of contacts in Eloqua, for global use.",
"properties":{
"count":{
"title":"count",
"description":"The number of items returned.\r\n\r\nIn items: the number of records operated on for that message.",
"type":"integer"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the contact filter was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the contact filter field. This is a read-only property.",
"type":"string"
},
"executedAt":{
"format":"date-time",
"title":"executedAt",
"description":"The time and date the contact filter was last used.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the contact definition.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"ContactList":{
"title":"ContactList",
"description":"The definition of a static list of contacts in Eloqua, for global use.",
"properties":{
"count":{
"title":"count",
"description":"Number of results returned in the request.",
"type":"integer"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"name":{
"title":"name",
"description":"The contact list's name.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the contact list was last updated, expressed using the ISO-8601 standard.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"StandardLeadScoringModelField":{
"title":"StandardLeadScoringModelField",
"description":"Standard Lead Score Model definition field",
"properties":{
"dataType":{
"$ref":"#/definitions/DataType"
},
"defaultValue":{
"title":"defaultValue",
"description":"The field's default value.",
"type":"string"
},
"hasNotNullConstraint":{
"title":"hasNotNullConstraint",
"description":"Indicates whether the field can have null values (i.e. empty).",
"type":"boolean"
},
"hasReadOnlyConstraint":{
"title":"hasReadOnlyConstraint",
"description":"Indicates whether the field can be written to.",
"type":"boolean"
},
"hasUniquenessConstraint":{
"title":"hasUniquenessConstraint",
"description":"Indicates whether the field must have a unique value.",
"type":"boolean"
},
"internalName":{
"title":"internalName",
"description":"The field's internal name (used to uniquely identify it).",
"type":"string"
},
"name":{
"title":"name",
"description":"The asset's name.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"LeadScoreModel":{
"title":"LeadScoreModel",
"description":"The definition of a lead score model in BulkApi.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"fields":{
"title":"fields",
"description":"List of fields to be included in the operation.",
"type":"array",
"items":{
"$ref":"#/definitions/StandardLeadScoringModelField"
}
},
"id":{
"title":"id",
"description":"The lead scoring model identifier.",
"type":"integer"
},
"name":{
"title":"name",
"description":"The lead scoring model's name.",
"type":"string"
},
"status":{
"title":"status",
"description":"The status of the lead scoring model.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"ContactSegment":{
"title":"ContactSegment",
"description":"The definition of a segment of contacts in Eloqua, for global use. A segment is a combination of contact lists and contact filters.",
"properties":{
"count":{
"title":"count",
"description":"The number of items returned.\r\n\r\nIn items: the number of records operated on for that message.",
"type":"integer"
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the contact segment was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the contact segment. This is a read-only property.",
"type":"string"
},
"executedAt":{
"format":"date-time",
"title":"executedAt",
"description":"The time and date the contact segment was last used.",
"type":"string"
},
"name":{
"title":"name",
"description":"The contact list's name.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the contact segment was last updated, expressed using the ISO-8601 standard.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the contact segment.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"QueryResultProfileFieldRest20":{
"title":"QueryResultProfileField",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of visitor profile fields.",
"items":{
"$ref":"#/definitions/ProfileFieldRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"ProfileFieldRest20":{
"title":"ProfileField",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the visitor profile field. This is a read-only property."
},
"name":{
"type":"string",
"description":"The name of the visitor profile field. "
},
"createdByName":{
"type":"string",
"description":"ProfileField_Field_CreatedByName_Description"
},
"updatedByName":{
"type":"string",
"description":"ProfileField_Field_UpdatedByName_Description"
},
"internalName":{
"type":"string",
"description":"The internal name of the visitor profile field."
},
"dataType":{
"type":"string",
"description":"The visitor profile field's data type. Possible values are: text, 'text', 'largeText', 'date', or 'number'."
},
"length":{
"type":"string",
"description":"The value length of the field expressed in bytes."
}
}
},
"CustomObjectRest10":{
"title":"CustomObject",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the custom object."
},
"currentStatus":{
"type":"string",
"description":"This property is not used for custom object fields."
},
"name":{
"type":"string",
"description":"The name of the custom object."
},
"description":{
"type":"string",
"description":"The description of the custom object."
},
"permissions":{
"type":"string",
"description":"The permissions for the custom object granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the custom object."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the custom object was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the custom object."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the custom object was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"fields":{
"type":"array",
"description":"Array consisting of custom object field properties.",
"items":{
"$ref":"#/definitions/CustomObjectFieldRest10"
}
},
"displayNameFieldId":{
"type":"string",
"description":"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":{
"type":"string",
"description":"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":{
"type":"string",
"description":"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 false. This feature is released under our Controlled Availability program. You can request access to this feature by submitting a request to My Oracle Support."
}
}
},
"QueryResultCustomObjectRest10":{
"title":"QueryResultCustomObject",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of custom object fields.",
"items":{
"$ref":"#/definitions/CustomObjectRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"CustomObjectFieldRest10":{
"title":"CustomObjectField",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"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":{
"type":"string",
"description":"This property is not used for custom objects."
},
"description":{
"type":"string",
"description":"This property is not used for custom object fields."
},
"permissions":{
"type":"string",
"description":"This property is not used."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"This property is not used for custom object fields."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"This property is not used for custom object fields."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"This property is not used for custom object fields."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"This property is not used for custom object fields."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"name":{
"type":"string",
"description":"The name of the custom object field."
},
"displayType":{
"type":"string",
"description":"The custom object field's display type."
},
"dataType":{
"type":"string",
"description":"The custom object field's data type."
},
"defaultValue":{
"type":"string",
"description":"The custom object field's default value."
}
}
},
"ContactRest20":{
"title":"Contact",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the contact. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The contact's current status."
},
"name":{
"type":"string",
"description":"The name of the contact."
},
"description":{
"type":"string",
"description":"The description of the contact."
},
"permissions":{
"type":"array",
"description":"The permissions for the contact granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the contact."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the asset."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the contact."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the contact."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the contact was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the contact."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the contact."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the contact was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the contact is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"firstName":{
"type":"string",
"description":"The contact's first name."
},
"lastName":{
"type":"string",
"description":"The contact's last name."
},
"emailAddress":{
"type":"string",
"description":"The contact's email address."
},
"emailFormatPreference":{
"type":"string",
"description":"The contact's email format preference."
},
"isSubscribed":{
"type":"string",
"description":"Whether or not the contact is subscribed."
},
"isSmsSubscribed":{
"type":"string",
"description":"Whether or not the contact is subscribed for SMS."
},
"isBounceback":{
"type":"string",
"description":"Whether or not the contact has any associated bouncebacks."
},
"accountName":{
"type":"string",
"description":"The account name in which the contact belongs."
},
"accountId":{
"type":"string",
"description":"The account id in which the contact belongs. This is a read-only property."
},
"title":{
"type":"string",
"description":"The contact's title."
},
"subscriptionDate":{
"type":"string",
"description":"The contact's subscription date."
},
"unsubscriptionDate":{
"type":"string",
"description":"The contact's unsubscription date."
},
"bouncebackDate":{
"type":"string",
"description":"The contact's bounceback date."
},
"fieldValues":{
"type":"array",
"description":"Array containing type and id values for all of the contactFields associated with a given contact.",
"items":{
"$ref":"#/definitions/FieldValueRest20"
}
},
"address1":{
"type":"string",
"description":"The contact's first address."
},
"address2":{
"type":"string",
"description":"The contact's second address."
},
"address3":{
"type":"string",
"description":"The contact's third address."
},
"city":{
"type":"string",
"description":"The contact's city."
},
"province":{
"type":"string",
"description":"The contact's province."
},
"postalCode":{
"type":"string",
"description":"The contact's postal code."
},
"country":{
"type":"string",
"description":"The contact's country."
},
"businessPhone":{
"type":"string",
"description":"The contact's business phone number."
},
"mobilePhone":{
"type":"string",
"description":"The contact's mobile phone number."
},
"fax":{
"type":"string",
"description":"The contact's fax number."
},
"salesPerson":{
"type":"string",
"description":"The contact's account representative."
},
"stepEntryTime":{
"type":"string",
"description":"The time the contact was added to a step. This is a read-only property. This property can only be retrieved when a stepid is provided."
},
"nextEvaluationTime":{
"type":"string",
"description":"The time when the contact is scheduled to be processed. This is a read-only property. This property can only be retrieved when a stepid is provided."
},
"createdSourceType":{
"type":"string",
"description":"Contact_Field_CreatedSourceType_Description"
},
"updatedSourceType":{
"type":"string",
"description":"Contact_Field_UpdatedSourceType_Description"
}
}
},
"ContactListRest20":{
"title":"ContactList",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the contact list."
},
"currentStatus":{
"type":"string",
"description":"The contact list's current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"The contact list's name."
},
"description":{
"type":"string",
"description":"The description of the contact list."
},
"permissions":{
"type":"array",
"description":"The permissions for the contact list granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the contact list."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the contact list."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the contact list."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the contact list."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the contact segment was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the contact list."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the contact list."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the contact list was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the contact list is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"scope":{
"type":"string",
"description":"The contact list's scope: either local or global."
},
"count":{
"type":"string",
"readOnly":true,
"description":"The number of contacts in the contact list. This is a read-only property."
},
"membershipAdditions":{
"type":"array",
"description":"The number of contact membership additions in the contact list.",
"items":{
"type":"string"
}
},
"membershipDeletions":{
"type":"array",
"description":"The number of contact membership deletions in the contact list.",
"items":{
"type":"string"
}
},
"dataLookupId":{
"type":"string",
"description":"The contact list's data lookup Id. This is a read-only property."
}
}
},
"EntitySearchByIdsRest20":{
"title":"EntitySearchByIds",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. The default will be minimal. Learn more about the depth parameter."
},
"ids":{
"type":"array",
"description":"The ids to retrieve. Maximum of 200 ids per request. If the array contains duplicate ids, or exceeds the 200 limit, a 400 Bad Request will be returned.",
"items":{
"type":"integer"
}
}
}
},
"FormSubmissionActivities":{
"type":"object",
"properties":{
"fieldsCompletionRate":{
"format":"double",
"type":"number"
},
"fieldsIncompleteRate":{
"format":"double",
"type":"number"
},
"emailID":{
"format":"int32",
"type":"integer"
},
"formID":{
"format":"int32",
"type":"integer"
},
"eloquaCampaignID":{
"format":"int32",
"type":"integer"
},
"landingPageID":{
"format":"int32",
"type":"integer"
},
"webPageID":{
"format":"int32",
"type":"integer"
},
"numberofFields":{
"format":"int32",
"type":"integer"
},
"formCompletedFields":{
"format":"int32",
"type":"integer"
},
"totalFormsSubmissions":{
"format":"int32",
"type":"integer"
},
"formSubmissionDateHour":{
"format":"date-time",
"type":"string"
},
"calendar":{
"$ref":"#/definitions/Calendar"
},
"landingPageAsset":{
"$ref":"#/definitions/LandingPageAsset"
},
"webPage":{
"$ref":"#/definitions/WebPage"
},
"campaign":{
"$ref":"#/definitions/Campaign"
},
"emailAsset":{
"$ref":"#/definitions/EmailAsset"
}
}
},
"WebPage":{
"type":"object",
"properties":{
"webPageID":{
"format":"int32",
"type":"integer"
},
"webPageURL":{
"type":"string"
},
"webPageDisplayName":{
"type":"string"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
},
"formSubmissionActivities":{
"type":"array",
"items":{
"$ref":"#/definitions/FormSubmissionActivities"
}
}
}
},
"ODataQueryOptions[FormAsset]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"FormAsset":{
"type":"object",
"properties":{
"formID":{
"format":"int32",
"type":"integer"
},
"formName":{
"type":"string"
},
"isDeleted":{
"type":"boolean"
},
"isArchived":{
"type":"boolean"
},
"formExpired":{
"type":"boolean"
},
"formHostType":{
"type":"string"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
}
}
},
"ODataQueryOptions[FormSubmissionActivities]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"ODataQueryOptions[WebPage]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"PhoneNumberSubscriptionRest20":{
"title":"PhoneNumberSubscription",
"properties":{
"type":{
"type":"string",
"description":"PhoneNumberSubscription_Field_Type_Description"
},
"status":{
"type":"string",
"description":"PhoneNumberSubscription_Field_Status_Description"
},
"timestamp":{
"type":"string",
"description":"PhoneNumberSubscription_Field_Timestamp_Description"
},
"originalPhoneNumber":{
"type":"string",
"description":"PhoneNumberSubscription_Field_OriginalPhoneNumber_Description"
},
"normalizedPhoneNumber":{
"type":"string",
"description":"PhoneNumberSubscription_Field_NormalizedPhoneNumber_Description"
},
"history":{
"type":"array",
"description":"PhoneNumberSubscription_Field_History_Description",
"items":{
"$ref":"#/definitions/PhoneNumberSubscriptionHistoryRest20"
}
}
}
},
"PhoneNumberSubscriptionDetailsRest20":{
"title":"PhoneNumberSubscriptionDetails",
"properties":{
"type":{
"type":"string",
"description":"PhoneNumberSubscriptionDetails_Field_Type_Description"
},
"isSubscribed":{
"type":"string",
"description":"PhoneNumberSubscriptionDetails_Field_IsSubscribed_Description"
},
"phoneNumber":{
"type":"string",
"description":"PhoneNumberSubscriptionDetails_Field_PhoneNumber_Description"
},
"entityId":{
"type":"string",
"description":"PhoneNumberSubscriptionDetails_Field_EntityId_Description"
},
"entityType":{
"type":"string",
"description":"PhoneNumberSubscriptionDetails_Field_EntityType_Description"
},
"entityFieldId":{
"type":"string",
"description":"PhoneNumberSubscriptionDetails_Field_EntityFieldId_Description"
}
}
},
"PhoneNumberSubscriptionSearchRest20":{
"title":"PhoneNumberSubscriptionSearch",
"properties":{
"type":{
"type":"string",
"description":"PhoneNumberSubscriptionSearch_Field_Type_Description"
},
"depth":{
"type":"string",
"readOnly":true,
"description":"PhoneNumberSubscriptionSearch_Field_Depth_Description"
},
"phoneNumbers":{
"type":"array",
"description":"PhoneNumberSubscriptionSearch_Field_PhoneNumbers_Description",
"items":{
"type":"string"
}
}
}
},
"PhoneNumberSubscriptionHistoryRest20":{
"title":"PhoneNumberSubscriptionHistory",
"properties":{
"type":{
"type":"string"
},
"status":{
"type":"string"
},
"timestamp":{
"type":"string"
},
"userId":{
"$ref":"#/definitions/System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]Rest20"
},
"sourceType":{
"type":"string",
"enum":[
"CreateEntity",
"UpdateEntity",
"ContactAsynchronousClear",
"BulkUpdate",
"WorkFlowUpdateRule",
"ProgramBuilderUpdateRule",
"ProgramBuilderDedupeHandler",
"BulkApi",
"DataImport",
"SharedListRunUpdateRule",
"InitialLoad",
"SmsSubscriptionRestApi",
"SmsSubscriptionBulkApi",
"SmsSubscriptionDataImport",
"SmsReply",
"Visitor"
]
}
}
},
"CustomObjectDataRest20":{
"title":"CustomObjectData",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the custom object data."
},
"currentStatus":{
"type":"string",
"description":"The custom object data's current status."
},
"name":{
"type":"string",
"description":"The name of the custom object data."
},
"description":{
"type":"string",
"description":"The description of the custom object data."
},
"permissions":{
"type":"array",
"description":"The permissions for the custom object data granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the custom object data."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the asset."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the custom object data. This is a read-only property."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the custom object data."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the custom object data was created, expressed in Unix time. This is a read-only property."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the custom object data."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the custom object data."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the custom object data was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the custom object data is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"contactId":{
"type":"string",
"description":"The contact record Id associated to this custom object data."
},
"accountId":{
"type":"string",
"description":"The account record Id associated to this custom object data. This is a read-only property."
},
"uniqueCode":{
"type":"string",
"description":"The unique code associated to the custom object data."
},
"customObjectRecordStatus":{
"type":"string",
"description":"The record status of the custom object data."
},
"fieldValues":{
"type":"array",
"description":"Array containing type and id 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.",
"items":{
"$ref":"#/definitions/FieldValueRest20"
}
},
"isMapped":{
"type":"string",
"description":"Whether or not the custom object data is mapped to a custom object."
}
}
},
"QueryResultCustomObjectDataRest20":{
"title":"QueryResultCustomObjectData",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. "
},
"elements":{
"type":"array",
"description":"Array of custom object field elements.",
"items":{
"$ref":"#/definitions/CustomObjectDataRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"EmailGroup":{
"title":"EmailGroup",
"description":"The definition of a grouping of emails in Eloqua, used for subscription management.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the email address definition.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"QueryResultSecurityGroupRest20":{
"title":"QueryResultSecurityGroup",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of security group fields.",
"items":{
"$ref":"#/definitions/SecurityGroupRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"QueryResultSecurityGroupUserRest20":{
"title":"QueryResultSecurityGroupUser",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of security group user data.",
"items":{
"$ref":"#/definitions/SecurityGroupUserRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"SecurityGroupUserRest20":{
"title":"SecurityGroupUser",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"patchMethod":{
"type":"string",
"description":"The patch method to perform"
},
"user":{
"$ref":"#/definitions/UserRest20",
"description":"User object"
}
}
},
"QueryResultDedupeRuleRest20":{
"title":"QueryResultDedupeRule",
"properties":{
"type":{
"type":"string",
"description":"The Dedupe rule type in Eloqua"
},
"elements":{
"type":"array",
"description":"Array of the Dedupe Rule fields",
"items":{
"$ref":"#/definitions/DedupeRuleRest20"
}
},
"total":{
"type":"integer",
"description":"Total number of Dedupe Rules returned"
},
"pageSize":{
"type":"integer",
"description":"The Page size"
},
"page":{
"type":"integer",
"description":"The Specified page"
}
}
},
"QueryResultDedupeRuleHandlerSetRest20":{
"title":"QueryResultDedupeRuleHandlerSet",
"properties":{
"type":{
"type":"string",
"description":"The element's type in Eloqua"
},
"elements":{
"type":"array",
"description":"Array of dedupe rule handler sets",
"items":{
"$ref":"#/definitions/DedupeRuleHandlerSetRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"DedupeRuleHandlerSetRest20":{
"title":"DedupeRuleHandlerSet",
"properties":{
"type":{
"type":"string"
},
"id":{
"type":"string",
"readOnly":true
},
"currentStatus":{
"type":"string"
},
"name":{
"type":"string"
},
"description":{
"type":"string"
},
"permissions":{
"type":"array",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true
},
"sourceTemplateId":{
"type":"string"
},
"createdBy":{
"type":"string",
"readOnly":true
},
"createdByName":{
"type":"string"
},
"createdAt":{
"type":"string",
"readOnly":true
},
"updatedBy":{
"type":"string",
"readOnly":true
},
"updatedByName":{
"type":"string"
},
"updatedAt":{
"type":"string",
"readOnly":true
},
"scheduledFor":{
"type":"string",
"readOnly":true
},
"depth":{
"type":"string",
"readOnly":true
},
"deletePermanentlyFromDestination":{
"type":"string"
},
"isNonMatchesDestination":{
"type":"string"
}
}
},
"DedupeRuleRest20":{
"title":"DedupeRule",
"properties":{
"type":{
"type":"string"
},
"id":{
"type":"string",
"readOnly":true
},
"currentStatus":{
"type":"string"
},
"name":{
"type":"string"
},
"description":{
"type":"string"
},
"permissions":{
"type":"array",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true
},
"sourceTemplateId":{
"type":"string"
},
"createdBy":{
"type":"string",
"readOnly":true
},
"createdByName":{
"type":"string"
},
"createdAt":{
"type":"string",
"readOnly":true
},
"updatedBy":{
"type":"string",
"readOnly":true
},
"updatedByName":{
"type":"string"
},
"updatedAt":{
"type":"string",
"readOnly":true
},
"scheduledFor":{
"type":"string",
"readOnly":true
},
"depth":{
"type":"string",
"readOnly":true
},
"sourceEntityType":{
"type":"string"
},
"targetEntityType":{
"type":"string"
},
"isMatchRule":{
"type":"string"
},
"isCompleted":{
"type":"string"
}
}
},
"AccountCampaignScore":{
"type":"object",
"properties":{
"accountCampaignScoreId":{
"format":"int32",
"type":"integer"
},
"eloquaCampaignId":{
"format":"int32",
"type":"integer"
},
"accountId":{
"format":"int32",
"type":"integer"
},
"score":{
"format":"double",
"type":"number"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
},
"account":{
"$ref":"#/definitions/Account"
}
}
},
"Opportunity":{
"type":"object",
"properties":{
"opportunityID":{
"format":"int32",
"type":"integer"
},
"opportunityName":{
"type":"string"
},
"stageStatus":{
"type":"string"
},
"opportunityClosedDateHour":{
"format":"date-time",
"type":"string"
},
"createdDate":{
"format":"date-time",
"type":"string"
},
"territory":{
"type":"string"
},
"stage":{
"type":"string"
},
"totalOpportunityAmount":{
"format":"double",
"type":"number"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
},
"primaryContactID":{
"format":"int32",
"type":"integer"
},
"crmCampaignID":{
"type":"string"
},
"opportunityRevenues":{
"type":"array",
"items":{
"$ref":"#/definitions/OpportunityRevenue"
}
},
"contact":{
"$ref":"#/definitions/Contact"
}
}
},
"OpportunityRevenue":{
"type":"object",
"properties":{
"eloquaCampaignID":{
"format":"int32",
"type":"integer"
},
"opportunityID":{
"format":"int32",
"type":"integer"
},
"attributedRevenue":{
"format":"double",
"type":"number"
},
"influencedRevenue":{
"format":"double",
"type":"number"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
},
"opportunity":{
"$ref":"#/definitions/Opportunity"
}
}
},
"ODataQueryOptions[AccountCampaignScore]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"ODataQueryOptions[Opportunity]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"ODataQueryOptions[OpportunityRevenue]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"QueryResultContentSectionRest10":{
"title":"QueryResultContentSection",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of content section fields.",
"items":{
"$ref":"#/definitions/ContentSectionRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"AccountRest10":{
"title":"Account",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the account. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The account's current status."
},
"name":{
"type":"string",
"description":"The name of the account."
},
"description":{
"type":"string",
"description":"The description of the account."
},
"permissions":{
"type":"string",
"description":"The permissions for the account granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the account."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the account was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the account."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the account was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"fieldValues":{
"type":"array",
"description":"Array containing type and id values for all of the accountFields associated with a given account.",
"items":{
"$ref":"#/definitions/FieldValueRest10"
}
},
"address1":{
"type":"string",
"description":"The account's first address."
},
"address2":{
"type":"string",
"description":"The account's second address."
},
"address3":{
"type":"string",
"description":"The account's third address."
},
"city":{
"type":"string",
"description":"The account's city."
},
"province":{
"type":"string",
"description":"The account's province."
},
"postalCode":{
"type":"string",
"description":"The account's postal code."
},
"country":{
"type":"string",
"description":"The account's country."
},
"businessPhone":{
"type":"string",
"description":"The account's business phone number."
},
"crmSystemMappings":{
"type":"array",
"description":"Lists CRM Users linked to the Account. Each crmSystemMappings contains a type, CRMUsername(s), and Eloqua loginName values for all of the Eloqua Users linked to the Account.\r\n\r\nThis 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 linkUsers parameter in this tutorial.\r\n\r\nThis property is also only returned when the request depth is complete.",
"items":{
"$ref":"#/definitions/CrmSystemMappingRest10"
}
}
}
},
"QueryResultAccountRest10":{
"title":"QueryResultAccount",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of account fields.",
"items":{
"$ref":"#/definitions/AccountRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"CrmSystemMappingRest10":{
"title":"CrmSystemMapping",
"properties":{
"type":{
"type":"string"
},
"id":{
"type":"string",
"readOnly":true
},
"currentStatus":{
"type":"string"
},
"name":{
"type":"string"
},
"description":{
"type":"string"
},
"permissions":{
"type":"string"
},
"createdBy":{
"type":"string",
"readOnly":true
},
"createdAt":{
"type":"string",
"readOnly":true
},
"updatedBy":{
"type":"string",
"readOnly":true
},
"updatedAt":{
"type":"string",
"readOnly":true
},
"depth":{
"type":"string",
"readOnly":true
},
"loginName":{
"type":"string"
},
"MSDUserName":{
"type":"string"
},
"SFDCUserName":{
"type":"string"
},
"SODUserName":{
"type":"string"
}
}
},
"CampaignRest20":{
"title":"Campaign",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the campaign."
},
"currentStatus":{
"type":"string",
"description":"The campaign's current status: Active, Draft, Scheduled, or Completed."
},
"name":{
"type":"string",
"description":"The name of the campaign."
},
"description":{
"type":"string",
"description":"The description of the campaign."
},
"permissions":{
"type":"array",
"description":"The permissions for the campaign granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the campaign."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the asset."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the campaign."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the campaign."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the campaign was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the campaign."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the campaign."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the campaign was last updated. This is a read-only property."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the campaign is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. For more information, see Request depth. "
},
"elements":{
"type":"array",
"description":"A list of campaign elements.",
"items":{
"$ref":"#/definitions/CampaignElementRest20"
}
},
"isReadOnly":{
"type":"string",
"description":"Whether or not the campaign is read only."
},
"runAsUserId":{
"type":"string",
"description":"The login id of the user to activate the campaign."
},
"isExitHistoryDisabled":{
"type":"string",
"description":"Campaign_Field_IsExitHistoryDisabled_Description"
},
"isBypassHistoryDisabled":{
"type":"string",
"description":"Campaign_Field_IsBypassHistoryDisabled_Description"
},
"startAt":{
"type":"string",
"description":"The date time for which the campaign will activate, expressed in Unix time."
},
"endAt":{
"type":"string",
"description":"The date and time the campaign will end."
},
"budgetedCost":{
"type":"string",
"description":"The campaign's projected cost."
},
"actualCost":{
"type":"string",
"description":"The campaign's actual cost."
},
"isMemberAllowedReEntry":{
"type":"string",
"description":"Whether or not members are allowed to re-enter the campaign."
},
"fieldValues":{
"type":"array",
"description":"Array containing type and id values for all of the contactFields associated with a given contact. For campaigns, \"fieldValues\" include all custom campaign fields (type, id, value).",
"items":{
"$ref":"#/definitions/FieldValueRest20"
}
},
"campaignType":{
"type":"string",
"description":"The campaign's type."
},
"product":{
"type":"string",
"description":"The campaign's product value."
},
"region":{
"type":"string",
"description":"The campaign's region value."
},
"clrEndDate":{
"type":"string",
"description":"The end date of the clr."
},
"adCampaignId":{
"type":"string",
"description":"Campaign_Field_AdCampaignId_Description"
},
"campaignClassification":{
"type":"string",
"description":"Campaign_Field_CampaignClassification_Description"
},
"referenceProduct":{
"type":"string",
"description":"Campaign_Field_ReferenceProduct_Description"
},
"crmId":{
"type":"string",
"description":"The id of the customer relationship management application. When sending update requests, if crmId is not included in the request and a crmId value exists, it will be blanked."
},
"crmIds":{
"type":"array",
"description":"Campaign_Field_crmIds_Description",
"items":{
"$ref":"#/definitions/ExternalCampaignMappingRest20"
}
},
"isSyncedWithCRM":{
"type":"string",
"description":"Whether or not the campaign is synced with a customer relationship management application."
},
"isIncludedInROI":{
"type":"string",
"description":"Whether or not the campaign is included in return on investment."
},
"badgeId":{
"type":"string",
"description":"The badge id of the campaign."
},
"isEmailMarketingCampaign":{
"type":"string",
"description":"Whether or not the campaign is an email marketing campaign."
},
"campaignCategory":{
"type":"string",
"description":"Defines whether a Campaign is simple or multi-step. The value emailMarketing should be used for simple campaigns, and contact for multi-step campaigns."
},
"firstActivation":{
"type":"string",
"readOnly":true,
"description":"The date and time the campaign was originally activated."
},
"memberCount":{
"type":"string",
"readOnly":true,
"description":"The amount of members that entered the campaign in the last 90 days. This property is only returned when depth is set to partial or complete. This is a read-only property."
},
"isUpdatingCrmId":{
"type":"string",
"description":"Campaign_Field_IsUpdatingCrmId_Description"
}
}
},
"QueryResultCampaignRest20":{
"title":"QueryResultCampaign",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of campaign fields.",
"items":{
"$ref":"#/definitions/CampaignRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"ExternalCampaignMappingRest20":{
"title":"ExternalCampaignMapping",
"properties":{
"type":{
"type":"string"
},
"externalSystemId":{
"type":"integer"
},
"value":{
"type":"string"
}
}
},
"FormDataRest20":{
"title":"FormData",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property"
},
"id":{
"type":"string",
"readOnly":true,
"description":"The ID of the form submit if synchronous or ID of the form submission job if asynchronous. This is a read-only property"
},
"currentStatus":{
"type":"string",
"description":"The current status of the form submission job. Possible values: Queued, InProgress, Error, and Success."
},
"submittedAt":{
"type":"string",
"description":"Unix timestamp for the date and time the form data was submitted. This is a read-only property"
},
"submittedByContactId":{
"type":"string",
"description":"The ID of the contact that submitted the form. This is a read-only property"
},
"fieldValues":{
"type":"array",
"description":"A list of key/value pairs identifying the form data (field name / value)",
"items":{
"$ref":"#/definitions/FieldValueRest20"
}
},
"processingStepErrors":{
"type":"array",
"description":"A list of Processing Step Errors occurred in current form submission. This is a read-only property",
"items":{
"$ref":"#/definitions/ProcessingStepErrorRest20"
}
},
"processedAt":{
"type":"string",
"description":"Unix timestamp for the date and time the form data was processed if submitted through asynchronous submission. This is a read-only property"
},
"rowId":{
"type":"integer",
"description":"In case of an asynchronous form submission if processed then submit ID of form submission. This is a read-only property"
},
"validationErrors":{
"type":"array",
"description":"Validation errors if any occured in form submission. This is a read-only property",
"items":{
"$ref":"#/definitions/ObjectValidationErrorRest20"
}
},
"correlationId":{
"type":"string",
"description":"The unique identifier of form submission within the batch. Optional String field. If present, must be unique across created batches. If correlationId is not unique, then the entire batch will fail. The correlationId is persisted and could be used to identify the form submit."
}
}
},
"QueryResultFormSubmissionRest20":{
"title":"QueryResultFormSubmission",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of form data elements.",
"items":{
"$ref":"#/definitions/FormDataRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"QueryResultAsyncFormSubmissionRest20":{
"title":"QueryResultAsyncFormSubmission",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of form submission data fields.",
"items":{
"$ref":"#/definitions/FormDataRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"QueryResultFormSpamSubmissionRest20":{
"title":"QueryResultFormSpamSubmission",
"properties":{
"type":{
"type":"string",
"description":"QueryResult1FormSpamSubmission_Field_Type_Description"
},
"elements":{
"type":"array",
"description":"QueryResult1FormSpamSubmission_Field_Elements_Description",
"items":{
"$ref":"#/definitions/FormSpamDataRest20"
}
},
"total":{
"type":"integer",
"description":"QueryResult1FormSpamSubmission_Field_TotalElements_Description"
},
"pageSize":{
"type":"integer",
"description":"QueryResult1FormSpamSubmission_Field_PageSize_Description"
},
"page":{
"type":"integer",
"description":"QueryResult1FormSpamSubmission_Field_PageIndex_Description"
}
}
},
"AsyncFormSubmissionBatchRest20":{
"title":"AsyncFormSubmissionBatch",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property"
},
"id":{
"type":"string",
"readOnly":true,
"description":"The ID of the asynchronous form submission batch. This is a read-only property"
},
"currentStatus":{
"type":"string",
"description":"Current status of form submission batch when submitted through asynchronous submission"
},
"callbackUrl":{
"type":"string",
"description":"The URL to be called back once processing of form submisssion batch is completed"
},
"batchCorrelationId":{
"type":"string",
"description":"The unique identifier of the batch. Optional String field. If present, must be unique across created batches. If batchCorrelationId is not unique, then the entire batch will fail. The batchCorrelationId is persisted and could be used to retrieve form batch details."
},
"depth":{
"type":"string",
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"elements":{
"type":"array",
"description":"A list of form data elements",
"items":{
"$ref":"#/definitions/FormDataRest20"
}
},
"currentBatchStatus":{
"type":"string",
"description":"The current status of the batch. Possible values: Queued, InProgress, Warning, Error, Success. This is a read-only property."
},
"processingStatus":{
"type":"string",
"description":"The processing status of the batch. This is a read-only property."
}
}
},
"ProcessingStepErrorRest20":{
"title":"ProcessingStepError",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"processingStepId":{
"type":"string",
"description":"Processing step id during which error ocurred"
},
"processingStepTypeId":{
"type":"string",
"description":"Type of the processing step during which error ocurred"
},
"processingStepDisplayName":{
"type":"string",
"description":"DisplayName of the processing step including description (if configured)"
},
"errorCode":{
"type":"integer",
"description":"Unique Error Code for current error"
},
"errorMessage":{
"type":"string",
"description":"Error message for current error code"
},
"errorDescription":{
"type":"string",
"description":"Detailed information about current error"
}
}
},
"ObjectValidationErrorRest20":{
"title":"ObjectValidationError",
"properties":{
"type":{
"type":"string"
},
"container":{
"$ref":"#/definitions/ObjectKeyRest20"
},
"property":{
"type":"string"
},
"value":{
"type":"string"
},
"requirement":{
"$ref":"#/definitions/RequirementRest20"
}
}
},
"FormSpamDataRest20":{
"title":"FormSpamData",
"properties":{
"type":{
"type":"string",
"description":"FormSpamSubmission_Field_Type_Description"
},
"id":{
"type":"string",
"readOnly":true,
"description":"FormSpamSubmission_Field_InternalId_Description"
},
"currentStatus":{
"type":"string",
"description":"FormSpamSubmission_Field_Status_Description"
},
"submittedAt":{
"type":"string",
"description":"Unix timestamp for the date and time the form data was submitted. This is a read-only property"
},
"fieldValues":{
"type":"array",
"description":"A list of key/value pairs identifying the form data (field name / value)",
"items":{
"$ref":"#/definitions/FieldValueRest20"
}
},
"formSubmissionSource":{
"type":"string",
"description":"Specifies the source of the form submission"
},
"blockReason":{
"type":"string",
"description":"Specifies the reason the form was blocked as spam"
}
}
},
"ObjectKeyRest20":{
"title":"ObjectKey",
"properties":{
"type":{
"type":"string"
},
"objectType":{
"type":"string"
},
"objectId":{
"type":"string"
},
"container":{
"$ref":"#/definitions/ObjectKeyRest20"
}
}
},
"RequirementRest20":{
"title":"Requirement",
"properties":{
"type":{
"type":"string"
}
}
},
"EmailGroupRest10":{
"title":"EmailGroup",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the email group. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The email group's current status."
},
"name":{
"type":"string",
"description":"The name of the email group."
},
"description":{
"type":"string",
"description":"The description of the email group."
},
"permissions":{
"type":"string",
"description":"The permissions for the email group granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the email group."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the email group was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the email group."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the email group was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"emailHeaderId":{
"type":"string",
"description":"Id of the email header."
},
"emailFooterId":{
"type":"string",
"description":"Id of the email footer."
},
"subscriptionLandingPageId":{
"type":"string",
"description":"Id of the subscription landing page."
},
"unsubscriptionLandingPageId":{
"type":"string",
"description":"Id of the unsubscribe landing page."
},
"isVisibleInPublicSubscriptionList":{
"type":"string",
"description":"Whether or not the email group is visible in the public subscriptions list."
},
"isVisibleInOutlookPlugin":{
"type":"string",
"description":"Whether or not the email group is visible in the Outlook plugin."
},
"emailIds":{
"type":"array",
"description":"Array containing the unique identifiers of the emails in the email group.",
"items":{
"type":"string"
}
},
"displayName":{
"type":"string",
"description":"The display name of the email group."
},
"subscriptionListId":{
"type":"string",
"description":"Id of the subscription list. This is a read-only property."
},
"unSubscriptionListId":{
"type":"string",
"description":"Id of the unsubscribe list. This is a read-only property."
},
"subscriptionListDataLookupId":{
"type":"string",
"description":"Id of the subscription list's data lookup."
},
"unSubscriptionListDataLookupId":{
"type":"string",
"description":"Id of the unsubscribe list's data lookup."
}
}
},
"QueryResultGroupRest10":{
"title":"QueryResultGroup",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of fields.",
"items":{
"$ref":"#/definitions/EmailGroupRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"CustomObjectField":{
"title":"CustomObjectField",
"description":"The definition of a field on the referenced custom object.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataType":{
"$ref":"#/definitions/DataType"
},
"defaultValue":{
"title":"defaultValue",
"description":"The field's default value.",
"type":"string"
},
"hasNotNullConstraint":{
"title":"hasNotNullConstraint",
"description":"Indicates whether the field can have null values (i.e. empty).",
"type":"boolean"
},
"hasReadOnlyConstraint":{
"title":"hasReadOnlyConstraint",
"description":"Indicates whether the field can be written to.",
"type":"boolean"
},
"hasUniquenessConstraint":{
"title":"hasUniquenessConstraint",
"description":"Indicates whether the field must have a unique value.",
"type":"boolean"
},
"internalName":{
"title":"internalName",
"description":"The field's internal name (used to uniquely identify it).",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the custom object definition.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"CustomObject":{
"title":"CustomObject",
"description":"The definition of a custom object. Custom Objects are used to store data that may be related to a Contact or Company's record. Some examples of data you might store in a custom object include: Product Purchase history, Registrations, Warranty Expiry. Custom objects can be synchronized with your CRM system on a scheduled basis.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"displayNameFieldUri":{
"title":"displayNameFieldUri",
"description":"The relative uri used to reference the custom object field that represents the display field, for this custom object.",
"type":"string"
},
"emailAddressFieldUri":{
"title":"emailAddressFieldUri",
"description":"The relative uri used to reference the custom object field that represents an email address, for this custom object.",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the custom object definition.",
"type":"string"
},
"uniqueFieldUri":{
"title":"uniqueFieldUri",
"description":"The relative uri used to reference the custom object field that has a uniqueness constraint on it, for this custom object.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"AccountRest20":{
"title":"Account",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the account. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The account's current status."
},
"name":{
"type":"string",
"description":"The name of the account."
},
"description":{
"type":"string",
"description":"The description of the account."
},
"permissions":{
"type":"array",
"description":"The permissions for the account granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true,
"description":"The folder id of the folder which contains the account."
},
"sourceTemplateId":{
"type":"string",
"description":"Id of the template used to create the asset."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the account."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the account."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the account was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the account."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the account."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the account was last updated."
},
"scheduledFor":{
"type":"string",
"readOnly":true,
"description":"The date the account is scheduled."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"address1":{
"type":"string",
"description":"The account's first address."
},
"address2":{
"type":"string",
"description":"The account's second address."
},
"address3":{
"type":"string",
"description":"The account's third address."
},
"city":{
"type":"string",
"description":"The account's city."
},
"province":{
"type":"string",
"description":"The account's province."
},
"postalCode":{
"type":"string",
"description":"The account's postal code."
},
"country":{
"type":"string",
"description":"The account's country."
},
"businessPhone":{
"type":"string",
"description":"The account's business phone number."
},
"fieldValues":{
"type":"array",
"description":"Array containing type and id values for all of the accountFields associated with a given account.",
"items":{
"$ref":"#/definitions/FieldValueRest20"
}
},
"crmSystemMappings":{
"type":"array",
"description":"Lists CRM Users linked to the Account. Each crmSystemMappings contains a type, CRMUsername(s), and Eloqua loginName values for all of the Eloqua Users linked to the Account.\r\n\r\nThis 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 linkUsers parameter in this tutorial.\r\n\r\nThis property is also only returned when the request depth is complete.",
"items":{
"$ref":"#/definitions/CrmSystemMappingRest20"
}
}
}
},
"CrmSystemMappingRest20":{
"title":"CrmSystemMapping",
"properties":{
"type":{
"type":"string"
},
"id":{
"type":"string",
"readOnly":true
},
"currentStatus":{
"type":"string"
},
"name":{
"type":"string"
},
"description":{
"type":"string"
},
"permissions":{
"type":"array",
"items":{
"type":"string"
}
},
"folderId":{
"type":"string",
"readOnly":true
},
"sourceTemplateId":{
"type":"string"
},
"createdBy":{
"type":"string",
"readOnly":true
},
"createdByName":{
"type":"string"
},
"createdAt":{
"type":"string",
"readOnly":true
},
"updatedBy":{
"type":"string",
"readOnly":true
},
"updatedByName":{
"type":"string"
},
"updatedAt":{
"type":"string",
"readOnly":true
},
"scheduledFor":{
"type":"string",
"readOnly":true
},
"depth":{
"type":"string",
"readOnly":true
},
"loginName":{
"type":"string"
},
"MSDUserName":{
"type":"string"
},
"SFDCUserName":{
"type":"string"
},
"SODUserName":{
"type":"string"
}
}
},
"OptionListRest10":{
"title":"OptionList",
"properties":{
"type":{
"type":"string",
"description":"The option list's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"The option list's unique identifier."
},
"currentStatus":{
"type":"string",
"description":"The option list's current status."
},
"name":{
"type":"string",
"description":"The name of the option list."
},
"description":{
"type":"string",
"description":"The description of the option list."
},
"permissions":{
"type":"string",
"description":"The permissions for the option list granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the option list."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the option list was created."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the option list."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the option list was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"elements":{
"type":"array",
"description":"A list of option elements.",
"items":{
"$ref":"#/definitions/OptionRest10"
}
}
}
},
"QueryResultOptionListRest10":{
"title":"QueryResultOptionList",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of option list fields.",
"items":{
"$ref":"#/definitions/OptionListRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"OptionRest10":{
"title":"Option",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. This asset is an \"Option\"."
},
"displayName":{
"type":"string",
"description":"The display name for the option that is displayed within the option list."
},
"value":{
"type":"string",
"description":"The option's internal value. This value is not displayed externally."
}
}
},
"ImportPriority":{
"title":"ImportPriority",
"description":"The definition of the import priority, for management of data source priority.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"name":{
"title":"name",
"description":"The asset's name.",
"type":"string"
},
"priority":{
"title":"priority",
"description":"The import's queue position. This is a read-only property.",
"type":"integer"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"ContactSegmentRest10":{
"title":"ContactSegment",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the contact segment. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The contact segment's current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"The contact segment's name."
},
"description":{
"type":"string",
"description":"The description of the contact segment."
},
"permissions":{
"type":"string",
"description":"The permissions for the contact segment granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the contact segment."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the contact segment was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the contact segment."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the contact segment was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"elements":{
"type":"array",
"description":"Array of contact segment elements.",
"items":{
"$ref":"#/definitions/SegmentElementRest10"
}
},
"count":{
"type":"string",
"description":"The number of contacts in the contact segment. This is a read-only property."
},
"lastCalculatedAt":{
"type":"string",
"description":"The date and time of the most recent calculation. This is a read-only property."
}
}
},
"QueryResultSegmentRest10":{
"title":"QueryResultSegment",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of segment fields.",
"items":{
"$ref":"#/definitions/ContactSegmentRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"SegmentElementRest10":{
"title":"SegmentElement",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the contact segment element. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The contact segment element's current status. This is a read-only property."
},
"name":{
"type":"string",
"description":"The name of the contact segment element. This is a read-only property."
},
"description":{
"type":"string",
"description":"The description of the contact segment element."
},
"permissions":{
"type":"string",
"description":"The permissions for the contact segment element granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the contact segment element."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the contact segment element was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the contact segment element."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the contact segment element was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"isIncluded":{
"type":"string",
"description":"The total amount of contacts within the segment element."
},
"count":{
"type":"string",
"description":"The number of contacts in the contact segment element. This is a read-only property."
},
"lastCalculatedAt":{
"type":"string",
"description":"The date and time the contact segment element was last calculated. This is a read-only property."
}
}
},
"QueryResultFormRest20":{
"title":"QueryResultForm",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of form elements.",
"items":{
"$ref":"#/definitions/FormRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"ActivityFilterType":{
"title":"ActivityFilterType",
"description":"The activity types available for the activity field.",
"default":"EmailSend",
"enum":[
"EmailSend",
"EmailOpen",
"EmailClickthrough",
"Subscribe",
"Unsubscribe",
"Bounceback",
"FormSubmit",
"PageView",
"WebVisit",
"ExternalActivity",
"SmsSend",
"SmsReply",
"SmsClickthrough"
],
"type":"string"
},
"ActivityField":{
"title":"ActivityField",
"description":"The definition of a activity field in the system.",
"properties":{
"activityTypes":{
"title":"activityTypes",
"description":"The activity types associated with the activity field. The possible activity types are: EmailSend, EmailOpen, EmailClickthrough, Subscribe, Unsubscribe, Bounceback, WebVisit, PageView, and FormSubmit. See Activity Fields for more information about activity fields.",
"type":"array",
"items":{
"$ref":"#/definitions/ActivityFilterType"
}
},
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataType":{
"$ref":"#/definitions/DataType"
},
"defaultValue":{
"title":"defaultValue",
"description":"The field's default value.",
"type":"string"
},
"hasNotNullConstraint":{
"title":"hasNotNullConstraint",
"description":"Indicates whether the field can have null values (i.e. empty).",
"type":"boolean"
},
"hasReadOnlyConstraint":{
"title":"hasReadOnlyConstraint",
"description":"Indicates whether the field can be written to.",
"type":"boolean"
},
"hasUniquenessConstraint":{
"title":"hasUniquenessConstraint",
"description":"Indicates whether the field must have a unique value.",
"type":"boolean"
},
"internalName":{
"title":"internalName",
"description":"The field's internal name (used to uniquely identify it).",
"type":"string"
},
"name":{
"title":"name",
"description":"The name of the activity definition.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
},
"LeadActivities":{
"type":"object",
"properties":{
"eloquaCampaignId":{
"format":"int32",
"type":"integer"
},
"leadResponseDateHour":{
"format":"date-time",
"type":"string"
},
"newContacts":{
"format":"int32",
"type":"integer"
},
"newLeads":{
"format":"int32",
"type":"integer"
},
"totalResponses":{
"format":"int32",
"type":"integer"
},
"campaign":{
"$ref":"#/definitions/Campaign"
}
}
},
"LandingPageActivities":{
"type":"object",
"properties":{
"landingPageTime":{
"format":"double",
"type":"number"
},
"landingPageActivitiesId":{
"format":"int32",
"type":"integer"
},
"eloquaCampaignId":{
"format":"int32",
"type":"integer"
},
"landingPageViews":{
"format":"int32",
"type":"integer"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
},
"dateHour":{
"format":"date-time",
"type":"string"
},
"assetId":{
"format":"int32",
"type":"integer"
},
"landingPageAsset":{
"$ref":"#/definitions/LandingPageAsset"
},
"campaign":{
"$ref":"#/definitions/Campaign"
},
"calendar":{
"$ref":"#/definitions/Calendar"
}
}
},
"WebActivities":{
"type":"object",
"properties":{
"webActivitiesId":{
"format":"int32",
"type":"integer"
},
"eloquaCampaignId":{
"format":"int32",
"type":"integer"
},
"totalPageViews":{
"format":"int32",
"type":"integer"
},
"totalVisitors":{
"format":"int32",
"type":"integer"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
},
"dateHour":{
"format":"date-time",
"type":"string"
},
"campaign":{
"$ref":"#/definitions/Campaign"
},
"calendar":{
"$ref":"#/definitions/Calendar"
}
}
},
"MarketingActivities":{
"type":"object",
"properties":{
"eloquaCampaignId":{
"format":"int32",
"type":"integer"
},
"totalOutboundActivities":{
"format":"int32",
"type":"integer"
},
"totalInboundActivities":{
"format":"int32",
"type":"integer"
},
"campaignMembers":{
"format":"int32",
"type":"integer"
},
"dateHourKey":{
"format":"date-time",
"type":"string"
},
"campaign":{
"$ref":"#/definitions/Campaign"
}
}
},
"ExternalActivityTotals":{
"type":"object",
"properties":{
"externalAssetId":{
"format":"int32",
"type":"integer"
},
"externalAssetType":{
"format":"int32",
"type":"integer"
},
"eloquaCampaignId":{
"format":"int32",
"type":"integer"
},
"totalExternalActivities":{
"format":"int32",
"type":"integer"
},
"dateHour":{
"format":"date-time",
"type":"string"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
},
"campaign":{
"$ref":"#/definitions/Campaign"
}
}
},
"EmailActivities":{
"type":"object",
"properties":{
"openRate":{
"format":"double",
"type":"number"
},
"clickthroughRate":{
"format":"double",
"type":"number"
},
"clickToOpenRate":{
"format":"double",
"type":"number"
},
"emailSentAggKey":{
"format":"int32",
"type":"integer"
},
"eloquaCampaignId":{
"format":"int32",
"type":"integer"
},
"emailId":{
"format":"int32",
"type":"integer"
},
"segmentId":{
"format":"int32",
"type":"integer"
},
"dateHour":{
"format":"date-time",
"type":"string"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
},
"totalSends":{
"format":"int32",
"type":"integer"
},
"totalDelivered":{
"format":"int32",
"type":"integer"
},
"totalHardBouncebacks":{
"format":"int32",
"type":"integer"
},
"totalSoftBouncebacks":{
"format":"int32",
"type":"integer"
},
"totalOpens":{
"format":"int32",
"type":"integer"
},
"totalClickthroughs":{
"format":"int32",
"type":"integer"
},
"totalPossibleForwarders":{
"format":"int32",
"type":"integer"
},
"totalUnsubscribesbyEmail":{
"format":"int32",
"type":"integer"
},
"totalBouncebacks":{
"format":"int32",
"type":"integer"
},
"totalSpamUnsubscribersByEmail":{
"format":"int32",
"type":"integer"
},
"existingVisitorClickthroughs":{
"format":"int32",
"type":"integer"
},
"newVisitorClickthroughs":{
"format":"int32",
"type":"integer"
},
"isOpened":{
"format":"int32",
"type":"integer"
},
"isClickThroughed":{
"format":"int32",
"type":"integer"
},
"segment":{
"$ref":"#/definitions/Segment"
},
"campaign":{
"$ref":"#/definitions/Campaign"
},
"calendar":{
"$ref":"#/definitions/Calendar"
},
"emailAsset":{
"$ref":"#/definitions/EmailAsset"
}
}
},
"FormActivities":{
"type":"object",
"properties":{
"formSubmitAggKey":{
"format":"int32",
"type":"integer"
},
"totalFormSubmissions":{
"format":"int32",
"type":"integer"
},
"eloquaCampaignID":{
"format":"int32",
"type":"integer"
},
"segmentId":{
"format":"int32",
"type":"integer"
},
"dateHour":{
"format":"date-time",
"type":"string"
},
"lastModifiedDate":{
"format":"date-time",
"type":"string"
},
"campaign":{
"$ref":"#/definitions/Campaign"
},
"calendar":{
"$ref":"#/definitions/Calendar"
},
"segment":{
"$ref":"#/definitions/Segment"
}
}
},
"ODataQueryOptions[EmailActivities]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"ODataQueryOptions[ExternalActivityTotals]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"ODataQueryOptions[FormActivities]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"ODataQueryOptions[LandingPageActivities]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"ODataQueryOptions[LeadActivities]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"ODataQueryOptions[MarketingActivities]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"ODataQueryOptions[WebActivities]":{
"type":"object",
"properties":{
"ifMatch":{
"type":"object",
"readOnly":true
},
"ifNoneMatch":{
"type":"object",
"readOnly":true
},
"request":{
"type":"object",
"readOnly":true
},
"context":{
"$ref":"#/definitions/ODataQueryContext",
"readOnly":true
},
"rawValues":{
"$ref":"#/definitions/ODataRawQueryOptions",
"readOnly":true
},
"selectExpand":{
"$ref":"#/definitions/SelectExpandQueryOption",
"readOnly":true
},
"apply":{
"$ref":"#/definitions/ApplyQueryOption",
"readOnly":true
},
"filter":{
"$ref":"#/definitions/FilterQueryOption",
"readOnly":true
},
"orderBy":{
"$ref":"#/definitions/OrderByQueryOption",
"readOnly":true
},
"skip":{
"$ref":"#/definitions/SkipQueryOption",
"readOnly":true
},
"skipToken":{
"$ref":"#/definitions/SkipTokenQueryOption",
"readOnly":true
},
"top":{
"$ref":"#/definitions/TopQueryOption",
"readOnly":true
},
"count":{
"$ref":"#/definitions/CountQueryOption",
"readOnly":true
},
"validator":{
"$ref":"#/definitions/ODataQueryValidator"
}
}
},
"EmailSignatureRuleRest20":{
"title":"EmailSignatureRule",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property."
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the signature rule. This is a read-only property."
},
"name":{
"type":"string",
"description":"The name of the signature rule."
},
"permissions":{
"type":"array",
"description":"The permissions for the signature rule granted to your current instance. This is a read-only property.",
"items":{
"type":"string"
}
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the signature rule."
},
"createdByName":{
"type":"string",
"description":"The name of the user who created the signature rule."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the signature rule was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who last updated the signature rule."
},
"updatedByName":{
"type":"string",
"description":"The name of the user who last updated the signature rule."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the signature rule was last updated, expressed in Unix time."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"defaultSenderId":{
"type":"string",
"description":"The id of the user that will be used as the default sender if no mappings are matched."
},
"contactFieldId":{
"type":"string",
"description":"The id for the contact field to be used when matching a contact to a mapping."
},
"customObjectFieldId":{
"type":"string",
"description":"The id for the custom object field to be used when matching a contact to a mapping."
},
"eventRegistrationFieldId":{
"type":"string",
"description":"The id for the event field to be used when matching a contact to a mapping."
},
"isPersonalizeFromName":{
"type":"string",
"description":"Flag to enable personalizing the from name."
},
"isPersonalizeFromAddress":{
"type":"string",
"description":"Flag to enable personalizing the from address."
},
"isPersonalizeReplyName":{
"type":"string",
"description":"Flag to enable personalizing the reply to name."
},
"isPersonalizeReplyAddress":{
"type":"string",
"description":"Flag to enable personalizing the reply to address."
}
}
},
"QueryResultRuleRest20":{
"title":"QueryResultRule",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of signature rules.",
"items":{
"$ref":"#/definitions/EmailSignatureRuleRest20"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"EmailFooterRest10":{
"title":"EmailFooter",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua. This is a read-only property. "
},
"id":{
"type":"string",
"readOnly":true,
"description":"Id of the email footer. This is a read-only property."
},
"currentStatus":{
"type":"string",
"description":"The email footer's current status."
},
"name":{
"type":"string",
"description":"The name of the email footer."
},
"description":{
"type":"string",
"description":"The description of the email footer."
},
"permissions":{
"type":"string",
"description":"The permissions for the email footer granted to your current instance. This is a read-only property."
},
"createdBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user who created the email footer."
},
"createdAt":{
"type":"string",
"readOnly":true,
"description":"The date and time the email footer was created, expressed in Unix time."
},
"updatedBy":{
"type":"string",
"readOnly":true,
"description":"The login id of the user that last updated the email footer."
},
"updatedAt":{
"type":"string",
"readOnly":true,
"description":"Unix timestamp for the date and time the email footer was last updated."
},
"depth":{
"type":"string",
"readOnly":true,
"description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth."
},
"body":{
"type":"string",
"description":"The email footers's html text content."
},
"text":{
"type":"string",
"description":"The raw text from the \"body\" parameter."
},
"fieldMerges":{
"type":"array",
"description":"A list of associated Field Merges.",
"items":{
"$ref":"#/definitions/FieldMergeRest10"
}
},
"hyperlinks":{
"type":"array",
"description":"A list of hyperlinks contained within the email footer.",
"items":{
"$ref":"#/definitions/HyperlinkRest10"
}
}
}
},
"QueryResultFooterRest10":{
"title":"QueryResultFooter",
"properties":{
"type":{
"type":"string",
"description":"The asset's type in Eloqua."
},
"elements":{
"type":"array",
"description":"Array of footer fields.",
"items":{
"$ref":"#/definitions/EmailFooterRest10"
}
},
"total":{
"type":"integer",
"description":"The total amount of results."
},
"pageSize":{
"type":"integer",
"description":"The page size."
},
"page":{
"type":"integer",
"description":"The specified page."
}
}
},
"OpportunityField":{
"title":"OpportunityField",
"description":"The definition of a field on all opportunities in the system.",
"properties":{
"createdAt":{
"format":"date-time",
"title":"createdAt",
"description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"createdBy":{
"title":"createdBy",
"description":"The login id of the user who created the entity. This is a read-only property.",
"type":"string"
},
"dataType":{
"$ref":"#/definitions/DataType"
},
"defaultValue":{
"title":"defaultValue",
"description":"The opportunity field's default value.",
"type":"string"
},
"hasNotNullConstraint":{
"title":"hasNotNullConstraint",
"description":"Indicates whether the field can have null values (i.e. empty).",
"type":"boolean"
},
"hasReadOnlyConstraint":{
"title":"hasReadOnlyConstraint",
"description":"Indicates whether the field can be written to.",
"type":"boolean"
},
"hasUniquenessConstraint":{
"title":"hasUniquenessConstraint",
"description":"Indicates whether the field must have a unique value.",
"type":"boolean"
},
"internalName":{
"title":"internalName",
"description":"The field's internal name (used to uniquely identify it).",
"type":"string"
},
"name":{
"title":"name",
"description":"The opportunity field's name.",
"type":"string"
},
"statement":{
"title":"statement",
"description":"The markup language statement used to reference the field in an import or export mapping.",
"type":"string"
},
"updatedAt":{
"format":"date-time",
"title":"updatedAt",
"description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
"type":"string"
},
"updatedBy":{
"title":"updatedBy",
"description":"The login id of the user that last updated the entity. This is a read-only property.",
"type":"string"
},
"uri":{
"title":"uri",
"description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
"type":"string"
}
}
}
},
"tags":[
{
"name":"Application/1.0/Accounts",
"description":"An Oracle Eloqua Account provides group contact information.\r\n\r\nLearn more about accounts."
},
{
"name":"Application/1.0/Activities",
"description":"Activities are tracked for individual contacts."
},
{
"name":"Application/1.0/Contact fields",
"description":"Contact fields are the fields associated with a specific contact asset.\r\n\r\nLearn more about contact fields."
},
{
"name":"Application/1.0/Contact list",
"description":"Customized lists of contacts."
},
{
"name":"Application/1.0/Contact segments",
"description":"Segments API endpoints.\r\n\r\nLearn more about segments."
},
{
"name":"Application/1.0/Contacts",
"description":"A contact is a data entity that contains the explicit data around an individual person in the database.\r\n\r\nLearn more about contacts."
},
{
"name":"Application/1.0/Content sections",
"description":"Content sections allow you to create shared content to use inside assets such as emails and landing pages.\r\n\r\nLearn more about shared content."
},
{
"name":"Application/1.0/Custom object data",
"description":"Custom object data are the records of custom object instances.\r\n\r\nLearn more about custom objects."
},
{
"name":"Application/1.0/Custom objects",
"description":"Custom objects are a complement to the standard Data Entities (i.e. Contacts, Companies). Essentially, custom objects are used for two main functions: linking directly to a Contact and performing actions based on information collected without duplication.\r\n\r\nLearn more about custom objects."
},
{
"name":"Application/1.0/Email folders",
"description":"Email folders organize your email assets.\r\n\r\nLearn more about emails."
},
{
"name":"Application/1.0/Email footers",
"description":"Email footers are used to customize the look and feel of the bottom of your email.\r\n\r\nLearn more about email footers."
},
{
"name":"Application/1.0/Email groups",
"description":"Email Groups are used to control default settings for similar types of emails. For instance, you can set the default header, footer, subscription landing page, and unsubscribe landing page for a set of email newsletters. Then your contacts can subscribe or unsubscribe at the group level to simplify subscription management. As an administrator, you can add or delete groups as required to control email subscriptions.\r\n\r\nLearn more about email groups."
},
{
"name":"Application/1.0/Email headers",
"description":"Email headers are used to customize the look and feel of the top of your email. Headers can be used in your emails for branding purposes (your company's logo), to provide links to other (external) resources, or to display the link for a contact to view the email in a browser. Email headers are automatically added to your email after selecting and saving the email group to which it belongs, but you can also select a different header on a per-email basis from the email header chooser.\r\n\r\nLearn more about email headers."
},
{
"name":"Application/1.0/Emails",
"description":"Despite vast innovations and improvements to other channels of communication with prospects, emails are still central to many marketing campaigns. You can reach a large number of existing and potential customers efficiently and cheaply through email messages. Eloqua includes robust email marketing capabilities that you can weave into your marketing campaigns.\r\n\r\nLearn more about emails."
},
{
"name":"Application/1.0/Form data",
"description":"Form data are the submissions for a form. \r\n\r\nLearn more about forms."
},
{
"name":"Application/1.0/Forms",
"description":"Form data are the submissions for a form. \r\n\r\nLearn more about Forms."
},
{
"name":"Application/1.0/Images",
"description":"Image assets to be used in places such as emails or landing pages.\r\n\r\nLearn more about images."
},
{
"name":"Application/1.0/Landing pages",
"description":"Landing pages are often the first significant part of a campaign that a contact will see. A contact may be directed to your landing page from a link in an email or from an ad on the web. The landing page provides the contact with more information and options related to the email or ad that brought them there. On the landing page they can be asked to participate in the campaign by reviewing detailed information, submitting a form, or clicking a button to receive additional information etc. The landing page moves prospects through your campaign and gives them a clearer idea about your product and your companies trustworthiness. \r\n\r\nLearn more about landing pages."
},
{
"name":"Application/1.0/Microsites",
"description":"A microsite is a miniature website, often dedicated to a specific campaign, product, or keyword. The purpose is to give a visitor (whether channeled through your website, social media assets, emails, SMS, or other channels) precise information that they can use to better understand your products and services or to make a buying decision. There are three types of microsites: basic, secure and authenticated. Each landing page you create in Eloqua must have an associated microsite.\r\n\r\nLearn more about microsites."
},
{
"name":"Application/1.0/Option lists",
"description":"Option lists are usually referred to on the marketers' side as select lists or pick lists.\r\n\r\nLearn more about option lists."
},
{
"name":"Application/1.0/Users",
"description":"Users API endpoints. The API allows you to modify such things as a user's time preference.\r\n\r\nLearn more about user management."
},
{
"name":"Application/2.0/Account groups",
"description":"An Oracle Eloqua Account Group provides the ability to group multiple companies into an Account Group.\r\n\r\nLearn more about accounts."
},
{
"name":"Application/2.0/Accounts",
"description":"An Oracle Eloqua Account provides group contact information.\r\n\r\nLearn more about accounts."
},
{
"name":"Application/2.0/Activities",
"description":"Activities API endpoint."
},
{
"name":"Application/2.0/Audit logs",
"description":"The Audit Log API endpoint enables initiating a request for Eloqua audit log exports using the Application API. Specify the type of audit log you want to export within a specified date and time range. If the request is successful, a report will be sent to the email address specified in the request."
},
{
"name":"Application/2.0/Campaign fields",
"description":"Campaign fields are the fields associated with a specific campaign asset.\r\n\r\nLearn more about campaign fields."
},
{
"name":"Application/2.0/Campaign folders",
"description":"Campaign folders organize your campaign assets."
},
{
"name":"Application/2.0/Campaigns",
"description":"Marketing campaigns are at the center of the Eloqua application, campaigns are comprised of different elements (such as segments, emails, landing pages, etc.) that are used to perform a variety of functions. You can combine the different elements in a number of ways to customize your campaign flow.\r\n\r\nLearn more about campaigns."
},
{
"name":"Application/2.0/Contact filter folders",
"description":"Contact filter folders organize your contact filters."
},
{
"name":"Application/2.0/Contact list folders",
"description":"Contact list folders organize your contact lists."
},
{
"name":"Application/2.0/Contact segment folders",
"description":"Contact segment folders to organize your segments."
},
{
"name":"Application/2.0/Contact segments",
"description":"Contact segments are groups of contacts generated based on filter criteria and contact lists.\r\n\r\nLearn more about Segments."
},
{
"name":"Application/2.0/Contacts",
"description":"A contact is a data entity that contains the explicit data around an individual person in the database.\r\n\r\nLearn more about contacts."
},
{
"name":"Application/2.0/Countries",
"description":"Countries API endpoints."
},
{
"name":"Application/2.0/Custom object data",
"description":"Custom object data are the records of custom object instances.\r\n\r\nLearn more about custom objects."
},
{
"name":"Application/2.0/Custom objects",
"description":"Custom objects are a complement to the standard Data Entities (i.e. Contacts, Companies). Essentially, custom objects are used for two main functions: linking directly to a Contact and performing actions based on information collected without duplication.\r\n\r\nLearn more about custom objects."
},
{
"name":"Application/2.0/Dedupe Rules",
"description":"Dedupe Rule endpoints"
},
{
"name":"Application/2.0/Email deployment",
"description":"The email deployment API is used to send and retrieve email deployments. There are two methods for creating and sending email deployments: to a single contact, or to a low volume of contacts (up to 100 contacts).\r\n\r\nLearn more about emails."
},
{
"name":"Application/2.0/Email folders",
"description":"Email folders organize your email assets."
},
{
"name":"Application/2.0/Emails",
"description":"Emails API Endpoints.\r\n\r\nLearn more about emails. Creating and updating emails with the type ResponsiveHtmlContent is not supported. If you use these endpoints with this email type, we cannot guarantee your email will be responsive."
},
{
"name":"Application/2.0/Event registrants",
"description":"The event registration API is used to manage event registrants. \r\n\r\nLearn more about Event Management."
},
{
"name":"Application/2.0/Events",
"description":"The events API is used to manage events.\r\n\r\nLearn more about Event Management."
},
{
"name":"Application/2.0/External activities",
"description":"External activities are non-Eloqua (that is, offline) activities performed by your contacts or prospects. These assets can be imported for use in Eloqua campaign reporting.\r\n\r\nExternal asset types is the 'umbrella' (top-level) classification for something that your contacts or prospects are performing, for example, a Tradeshow.\r\n\r\nLearn more about external assets."
},
{
"name":"Application/2.0/External asset types",
"description":"External activities are non-Eloqua (that is, offline) activities performed by your contacts or prospects. These assets can be imported for use in Eloqua campaign reporting.\r\n\r\nExternal asset types is the 'umbrella' (top-level) classification for something that your contacts or prospects are performing, for example, a Tradeshow.\r\n\r\nLearn more about external assets."
},
{
"name":"Application/2.0/External assets",
"description":"External assets are non-Eloqua (that is, offline) activities performed by your contacts or prospects. These assets can be imported for use in Eloqua campaign reporting.\r\n\r\nLearn more about external assets."
},
{
"name":"Application/2.0/Form data",
"description":"Form data are the submissions for a form.\r\n\t\r\nLearn more about Forms."
},
{
"name":"Application/2.0/Form folders",
"description":"Form folders organize your form assets."
},
{
"name":"Application/2.0/Forms",
"description":"Forms API endpoints.\r\n\t\r\nLearn more about Forms."
},
{
"name":"Application/2.0/Hyperlink folders",
"description":"Hyperlink folders organize your hyperlinks."
},
{
"name":"Application/2.0/Image folders",
"description":"Image folders organize your image assets."
},
{
"name":"Application/2.0/Landing pages",
"description":"Landing Pages API endpoints.\r\n\t\r\nLearn more about landing pages."
},
{
"name":"Application/2.0/Lookup tables",
"description":"Lookup table endpoints"
},
{
"name":"Application/2.0/Programs",
"description":"Programs API endpoints.\r\n\t\r\nLearn more about Programs."
},
{
"name":"Application/2.0/SMS",
"description":"SMS API endpoints."
},
{
"name":"Application/2.0/SMS codes",
"description":"SMS sender codes API endpoints."
},
{
"name":"Application/2.0/SMS folders",
"description":"SMS folders organize your SMS assets."
},
{
"name":"Application/2.0/SMS invalid keyword messages",
"description":"SMS invalid keyword response message API endpoints."
},
{
"name":"Application/2.0/SMS keywords",
"description":"SMS keywords API endpoints."
},
{
"name":"Application/2.0/SMS subscription",
"description":"The SMS subscription API is used to manage phone number consent."
},
{
"name":"Application/2.0/Security groups",
"description":"Security group API endpoints."
},
{
"name":"Application/2.0/Signature Rule Mappings",
"description":"Signature rule mappings API endpoints."
},
{
"name":"Application/2.0/Signature Rules",
"description":"Signature rules API endpoints."
},
{
"name":"Application/2.0/Users",
"description":"Users API endpoints."
},
{
"name":"Application/2.0/Visitor profile fields",
"description":"A visitor profile field are the fields associated to a website visitor. Learn more about Visitor Profile Fields."
},
{
"name":"Application/2.0/Visitors",
"description":"A visitor is a data entity that represents a unique cookie. The tracked activity data from that cookie is associated with the Visitor. There can be multiple visitors linked to a single contact."
},
{
"name":"Bulk/2.0/accounts",
"description":"The operations from the Bulk/2.0/accounts category."
},
{
"name":"Bulk/2.0/activities",
"description":"The operations from the Bulk/2.0/activities category."
},
{
"name":"Bulk/2.0/campaignResponses",
"description":"The operations from the Bulk/2.0/campaignResponses category."
},
{
"name":"Bulk/2.0/campaigns",
"description":"The operations from the Bulk/2.0/campaigns category."
},
{
"name":"Bulk/2.0/contacts",
"description":"The operations from the Bulk/2.0/contacts category."
},
{
"name":"Bulk/2.0/customObjects",
"description":"The operations from the Bulk/2.0/customObjects category."
},
{
"name":"Bulk/2.0/emailAddresses",
"description":"The operations from the Bulk/2.0/emailAddresses category."
},
{
"name":"Bulk/2.0/emailGroups",
"description":"The operations from the Bulk/2.0/emailGroups category."
},
{
"name":"Bulk/2.0/events",
"description":"The operations from the Bulk/2.0/events category."
},
{
"name":"Bulk/2.0/exports",
"description":"The operations from the Bulk/2.0/exports category."
},
{
"name":"Bulk/2.0/imports",
"description":"The operations from the Bulk/2.0/imports category."
},
{
"name":"Bulk/2.0/opportunities",
"description":"The operations from the Bulk/2.0/opportunities category."
},
{
"name":"Bulk/2.0/phoneNumbers",
"description":"The operations from the Bulk/2.0/phoneNumbers category."
},
{
"name":"Bulk/2.0/syncActions",
"description":"The operations from the Bulk/2.0/syncActions category."
},
{
"name":"Bulk/2.0/syncs",
"description":"The operations from the Bulk/2.0/syncs category."
},
{
"name":"Reporting/AccountActivity/1.0/Account",
"description":"The operations from the Reporting/AccountActivity/1.0/Account category."
},
{
"name":"Reporting/AccountActivity/1.0/AccountEngagement",
"description":"The operations from the Reporting/AccountActivity/1.0/AccountEngagement category."
},
{
"name":"Reporting/ActivityDetails/1.0/Campaign",
"description":"The operations from the Reporting/ActivityDetails/1.0/Campaign category."
},
{
"name":"Reporting/ActivityDetails/1.0/CampaignResponse",
"description":"The operations from the Reporting/ActivityDetails/1.0/CampaignResponse category."
},
{
"name":"Reporting/ActivityDetails/1.0/Contact",
"description":"The operations from the Reporting/ActivityDetails/1.0/Contact category."
},
{
"name":"Reporting/ActivityDetails/1.0/ContactIntegrationFields",
"description":"The operations from the Reporting/ActivityDetails/1.0/ContactIntegrationFields category."
},
{
"name":"Reporting/ActivityDetails/1.0/Device",
"description":"The operations from the Reporting/ActivityDetails/1.0/Device category."
},
{
"name":"Reporting/ActivityDetails/1.0/EloquaLinkedAccount",
"description":"The operations from the Reporting/ActivityDetails/1.0/EloquaLinkedAccount category."
},
{
"name":"Reporting/ActivityDetails/1.0/EmailAsset",
"description":"The operations from the Reporting/ActivityDetails/1.0/EmailAsset category."
},
{
"name":"Reporting/ActivityDetails/1.0/EmailAutoClick",
"description":"The operations from the Reporting/ActivityDetails/1.0/EmailAutoClick category."
},
{
"name":"Reporting/ActivityDetails/1.0/EmailAutoOpen",
"description":"The operations from the Reporting/ActivityDetails/1.0/EmailAutoOpen category."
},
{
"name":"Reporting/ActivityDetails/1.0/EmailBounceback",
"description":"The operations from the Reporting/ActivityDetails/1.0/EmailBounceback category."
},
{
"name":"Reporting/ActivityDetails/1.0/EmailClickthrough",
"description":"The operations from the Reporting/ActivityDetails/1.0/EmailClickthrough category."
},
{
"name":"Reporting/ActivityDetails/1.0/EmailGroup",
"description":"The operations from the Reporting/ActivityDetails/1.0/EmailGroup category."
},
{
"name":"Reporting/ActivityDetails/1.0/EmailGroupSubscriptionStatus",
"description":"The operations from the Reporting/ActivityDetails/1.0/EmailGroupSubscriptionStatus category."
},
{
"name":"Reporting/ActivityDetails/1.0/EmailOpen",
"description":"The operations from the Reporting/ActivityDetails/1.0/EmailOpen category."
},
{
"name":"Reporting/ActivityDetails/1.0/EmailSend",
"description":"The operations from the Reporting/ActivityDetails/1.0/EmailSend category."
},
{
"name":"Reporting/ActivityDetails/1.0/EmailUnsubscribe",
"description":"The operations from the Reporting/ActivityDetails/1.0/EmailUnsubscribe category."
},
{
"name":"Reporting/ActivityDetails/1.0/FormSubmission",
"description":"The operations from the Reporting/ActivityDetails/1.0/FormSubmission category."
},
{
"name":"Reporting/ActivityDetails/1.0/LandingPageVisit",
"description":"The operations from the Reporting/ActivityDetails/1.0/LandingPageVisit category."
},
{
"name":"Reporting/ActivityDetails/1.0/Referrer",
"description":"The operations from the Reporting/ActivityDetails/1.0/Referrer category."
},
{
"name":"Reporting/ActivityDetails/1.0/Segment",
"description":"The operations from the Reporting/ActivityDetails/1.0/Segment category."
},
{
"name":"Reporting/ActivityDetails/1.0/SpamUnsubscribesByEmail",
"description":"The operations from the Reporting/ActivityDetails/1.0/SpamUnsubscribesByEmail category."
},
{
"name":"Reporting/ActivityDetails/1.0/User",
"description":"The operations from the Reporting/ActivityDetails/1.0/User category."
},
{
"name":"Reporting/CampaignAnalysis/1.0/Calendar",
"description":"The operations from the Reporting/CampaignAnalysis/1.0/Calendar category."
},
{
"name":"Reporting/CampaignAnalysis/1.0/Campaign",
"description":"The operations from the Reporting/CampaignAnalysis/1.0/Campaign category."
},
{
"name":"Reporting/CampaignAnalysis/1.0/EmailActivities",
"description":"The operations from the Reporting/CampaignAnalysis/1.0/EmailActivities category."
},
{
"name":"Reporting/CampaignAnalysis/1.0/EmailAsset",
"description":"The operations from the Reporting/CampaignAnalysis/1.0/EmailAsset category."
},
{
"name":"Reporting/CampaignAnalysis/1.0/ExternalActivityTotals",
"description":"The operations from the Reporting/CampaignAnalysis/1.0/ExternalActivityTotals category."
},
{
"name":"Reporting/CampaignAnalysis/1.0/FormActivities",
"description":"The operations from the Reporting/CampaignAnalysis/1.0/FormActivities category."
},
{
"name":"Reporting/CampaignAnalysis/1.0/LandingPageActivities",
"description":"The operations from the Reporting/CampaignAnalysis/1.0/LandingPageActivities category."
},
{
"name":"Reporting/CampaignAnalysis/1.0/LandingPageAsset",
"description":"The operations from the Reporting/CampaignAnalysis/1.0/LandingPageAsset category."
},
{
"name":"Reporting/CampaignAnalysis/1.0/LeadActivities",
"description":"The operations from the Reporting/CampaignAnalysis/1.0/LeadActivities category."
},
{
"name":"Reporting/CampaignAnalysis/1.0/MarketingActivities",
"description":"The operations from the Reporting/CampaignAnalysis/1.0/MarketingActivities category."
},
{
"name":"Reporting/CampaignAnalysis/1.0/Segment",
"description":"The operations from the Reporting/CampaignAnalysis/1.0/Segment category."
},
{
"name":"Reporting/CampaignAnalysis/1.0/User",
"description":"The operations from the Reporting/CampaignAnalysis/1.0/User category."
},
{
"name":"Reporting/CampaignAnalysis/1.0/WebActivities",
"description":"The operations from the Reporting/CampaignAnalysis/1.0/WebActivities category."
},
{
"name":"Reporting/CampaignExternalActivity/1.0/ExternalActivities",
"description":"The operations from the Reporting/CampaignExternalActivity/1.0/ExternalActivities category."
},
{
"name":"Reporting/CampaignExternalActivity/1.0/ExternalActivityAttributes",
"description":"The operations from the Reporting/CampaignExternalActivity/1.0/ExternalActivityAttributes category."
},
{
"name":"Reporting/FormSubmission/1.0/Calendar",
"description":"The operations from the Reporting/FormSubmission/1.0/Calendar category."
},
{
"name":"Reporting/FormSubmission/1.0/Campaign",
"description":"The operations from the Reporting/FormSubmission/1.0/Campaign category."
},
{
"name":"Reporting/FormSubmission/1.0/EmailAsset",
"description":"The operations from the Reporting/FormSubmission/1.0/EmailAsset category."
},
{
"name":"Reporting/FormSubmission/1.0/FormAsset",
"description":"The operations from the Reporting/FormSubmission/1.0/FormAsset category."
},
{
"name":"Reporting/FormSubmission/1.0/FormSubmissionActivities",
"description":"The operations from the Reporting/FormSubmission/1.0/FormSubmissionActivities category."
},
{
"name":"Reporting/FormSubmission/1.0/LandingPageAsset",
"description":"The operations from the Reporting/FormSubmission/1.0/LandingPageAsset category."
},
{
"name":"Reporting/FormSubmission/1.0/User",
"description":"The operations from the Reporting/FormSubmission/1.0/User category."
},
{
"name":"Reporting/FormSubmission/1.0/WebPage",
"description":"The operations from the Reporting/FormSubmission/1.0/WebPage category."
},
{
"name":"Reporting/LandingPageAnalysis/1.0/Calendar",
"description":"The operations from the Reporting/LandingPageAnalysis/1.0/Calendar category."
},
{
"name":"Reporting/LandingPageAnalysis/1.0/LandingPageActivity",
"description":"The operations from the Reporting/LandingPageAnalysis/1.0/LandingPageActivity category."
},
{
"name":"Reporting/LandingPageAnalysis/1.0/LandingPageAsset",
"description":"The operations from the Reporting/LandingPageAnalysis/1.0/LandingPageAsset category."
},
{
"name":"Reporting/OpportunityAnalysis/1.0/Account",
"description":"The operations from the Reporting/OpportunityAnalysis/1.0/Account category."
},
{
"name":"Reporting/OpportunityAnalysis/1.0/AccountCampaignScore",
"description":"The operations from the Reporting/OpportunityAnalysis/1.0/AccountCampaignScore category."
},
{
"name":"Reporting/OpportunityAnalysis/1.0/AccountEngagement",
"description":"The operations from the Reporting/OpportunityAnalysis/1.0/AccountEngagement category."
},
{
"name":"Reporting/OpportunityAnalysis/1.0/Contact",
"description":"The operations from the Reporting/OpportunityAnalysis/1.0/Contact category."
},
{
"name":"Reporting/OpportunityAnalysis/1.0/Opportunity",
"description":"The operations from the Reporting/OpportunityAnalysis/1.0/Opportunity category."
},
{
"name":"Reporting/OpportunityAnalysis/1.0/OpportunityRevenue",
"description":"The operations from the Reporting/OpportunityAnalysis/1.0/OpportunityRevenue category."
}
]
}