Create a bulk export activity
post
/crmRestApi/resources/11.13.18.05/bulkExportActivities
Request
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
Activate: string
Title:
ActivateDefault Value:NOThe attribute that specifies whether to activate the export job or not. Once activated a job is queued for execution. -
Attachments: array
Export Attachments
Title:
Export AttachmentsThe attachment resource is used to export attachments for an object. -
BulkExportJobId: integer
(int64)
Title:
Export Job IdentifierThe unique identifier of the export job. -
Cancel: string
Used for canceling an export job through REST
-
childBulkExportActivity: array
Export Child Object Activities
Title:
Export Child Object ActivitiesThe export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels. -
DateFormat: string
Title:
Date FormatMaximum Length:120Default Value:ORA_ZCA_US_FORMATThe format of the date values in the exported file. -
Delimiter: string
Title:
DelimiterMaximum Length:30Default Value:COMMA_DELIMITERThe delimiter used for the exported file. -
Description: string
Title:
DescriptionMaximum Length:250The description for the export job that is provided by the user. -
EnableExportAttachment: string
Title:
Export attachmentsMaximum Length:20Default Value:NOEnables export of Attachments -
EnableSplit: string
Title:
Enable SplitMaximum Length:20Default Value:NOSpecifies if the export file should be split into multiple files. Select YES to split the export data set based on a specified record count. The default is NO. -
ErrorReportFileURL: string
Title:
Error File URLThe URL used for downloading the error file in a browser. For programmatic download of the error file zip file contents, follow the /enclosure/ErrorReportFileContents link. -
EscapeSpecialCharactersFlag: boolean
Title:
Escape Special CharactersIndicates whether to exclude any special characters like quotes, delimiter, new line and so on. The default value is false. -
ExportColumnNames: string
Title:
Export Column NamesThe object columns that are exported. -
ExportFileName: string
Title:
Export File NameMaximum Length:250The name of the exported file that is uploaded to the file repository. -
ExportFileURL: string
Title:
Export File URLThe URL used for downloading the export file in a browser. For programmatic download of the exported zip file contents, follow the /enclosure/ExportFileContents link. -
ExportFilterCriteria: string
Title:
Export Filter CriteriaMaximum Length:4000The export object filter criteria specifying which records will be exported. -
ExportMapping: string
Title:
Export MappingA previously defined object filter criteria and mapping which specifies the list of records that will be exported. -
ExportObject(required): string
Title:
Object CodeMaximum Length:128The name of the object that is exported. -
ExportOrderBy: string
Title:
Order ByMaximum Length:1000The order of the columns in the exported file. -
FileCharset: string
Title:
File EncodingMaximum Length:30Default Value:ORA_ZCA_UTF8_ENCODINGThe format in which the characters within your export file are encoded. -
LangIndependentHeader: string
Title:
Enable Round TripThe language independent header for the exported file that is used to enable the round trip of job and automatic mapping. -
Name(required): string
Title:
NameMaximum Length:100The name provided for each individual export job. -
NoteObjectCode: string
Title:
Note ObjectThe Export Object Code for which Note has to be exported. -
NotificationEMail: string
Title:
Notification EmailMaximum Length:500The email ID to which the export job status emails are sent. -
PrivateMap: string
Private maps are persistant and can only be viewed or deleted by the owner.
-
RestNotification: string
Specifies the REST Endpoint name, to which the notification will be sent after completion of the export job.
-
SplitSize: integer
(int64)
Title:
Split SizeSpecifies the split size when split is enabled. You can specify the split size in multiples of 100000 records. The default value is 100000. -
Status: string
Title:
StatusMaximum Length:30Default Value:NEWThe status of the export job. -
TimestampFormat: string
Title:
Time Stamp FormatMaximum Length:120Default Value:ORA_ZCA_US_FORMATThe format of the time stamp values in the exported file.
Nested Schema : Export Attachments
Type:
arrayTitle:
Export AttachmentsThe attachment resource is used to export attachments for an object.
Show Source
Nested Schema : Export Child Object Activities
Type:
arrayTitle:
Export Child Object ActivitiesThe export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.
Show Source
Nested Schema : bulkExportActivities-Attachments-item-post-request
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdThe unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEThe code indicating the data type. A list of valid values is defined in the lookup WEB_PAGE. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URL of the attached file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name of the attachment file. -
UploadedText: string
Title:
Uploaded TextThe text of the attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of the attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of the attachment.
Nested Schema : schema
Type:
Show Source
object-
childBulkExportActivity: array
Export Child Object Activities
Title:
Export Child Object ActivitiesThe export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels. -
ExportColumnNames: string
Title:
Export Column NamesThe object columns that are exported. -
ExportFilterCriteria: string
Title:
Export Filter CriteriaMaximum Length:4000The export object filter criteria specifying which records will be exported. -
ExportObject(required): string
Title:
Object CodeMaximum Length:128The name of the object that is exported. -
ExportOrderBy: string
Title:
Order ByMaximum Length:1000The order of the columns in the exported file. -
ExportParentObject: string
Title:
Export Parent ObjectMaximum Length:128The name of the parent object that is exported.
Nested Schema : Export Child Object Activities
Type:
arrayTitle:
Export Child Object ActivitiesThe export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.
Show Source
Nested Schema : schema
Type:
Show Source
object-
ExportColumnNames: string
Title:
Export Column NamesThe object columns that are exported. -
ExportFilterCriteria: string
Title:
Export Filter CriteriaMaximum Length:4000The export object filter criteria specifying which records will be exported. -
ExportObject: string
Title:
Object CodeMaximum Length:128The name of the object that is exported. -
ExportOrderBy: string
Title:
Order ByMaximum Length:1000The order of the columns in the exported file. -
ExportParentObject: string
Title:
Export Parent ObjectMaximum Length:128The name of the parent object that is exported.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : bulkExportActivities-item-response
Type:
Show Source
object-
Activate: string
Title:
ActivateDefault Value:NOThe attribute that specifies whether to activate the export job or not. Once activated a job is queued for execution. -
Attachments: array
Export Attachments
Title:
Export AttachmentsThe attachment resource is used to export attachments for an object. -
BulkExportJobId: integer
(int64)
Title:
Export Job IdentifierThe unique identifier of the export job. -
Cancel: string
Used for canceling an export job through REST
-
CanceledBy: string
Read Only:
trueIndicates User who canceled export job -
childBulkExportActivity: array
Export Child Object Activities
Title:
Export Child Object ActivitiesThe export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the record was created. -
CurrentLoggedInUser: string
Read Only:
trueSpecifies current logged in user -
DateFormat: string
Title:
Date FormatMaximum Length:120Default Value:ORA_ZCA_US_FORMATThe format of the date values in the exported file. -
Delimiter: string
Title:
DelimiterMaximum Length:30Default Value:COMMA_DELIMITERThe delimiter used for the exported file. -
Description: string
Title:
DescriptionMaximum Length:250The description for the export job that is provided by the user. -
EnableExportAttachment: string
Title:
Export attachmentsMaximum Length:20Default Value:NOEnables export of Attachments -
EnableSplit: string
Title:
Enable SplitMaximum Length:20Default Value:NOSpecifies if the export file should be split into multiple files. Select YES to split the export data set based on a specified record count. The default is NO. -
EndTm: string
Title:
End TimeRead Only:trueThe time at which the export job ends. -
ErrorReportFileContents: string
(byte)
Read Only:
trueThe contents of the attached export error file. -
ErrorReportFileURL: string
Title:
Error File URLThe URL used for downloading the error file in a browser. For programmatic download of the error file zip file contents, follow the /enclosure/ErrorReportFileContents link. -
EscapeSpecialCharactersFlag: boolean
Title:
Escape Special CharactersIndicates whether to exclude any special characters like quotes, delimiter, new line and so on. The default value is false. -
ExportColumnNames: string
Title:
Export Column NamesThe object columns that are exported. -
ExportFileContents: string
(byte)
Read Only:
trueThe contents of the attached export file. -
ExportFileName: string
Title:
Export File NameMaximum Length:250The name of the exported file that is uploaded to the file repository. -
ExportFileURL: string
Title:
Export File URLThe URL used for downloading the export file in a browser. For programmatic download of the exported zip file contents, follow the /enclosure/ExportFileContents link. -
ExportFilterCriteria: string
Title:
Export Filter CriteriaMaximum Length:4000The export object filter criteria specifying which records will be exported. -
ExportMapping: string
Title:
Export MappingA previously defined object filter criteria and mapping which specifies the list of records that will be exported. -
ExportObject: string
Title:
Object CodeMaximum Length:128The name of the object that is exported. -
ExportOrderBy: string
Title:
Order ByMaximum Length:1000The order of the columns in the exported file. -
FileCharset: string
Title:
File EncodingMaximum Length:30Default Value:ORA_ZCA_UTF8_ENCODINGThe format in which the characters within your export file are encoded. -
LangIndependentHeader: string
Title:
Enable Round TripThe language independent header for the exported file that is used to enable the round trip of job and automatic mapping. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login of the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Title:
NameMaximum Length:100The name provided for each individual export job. -
NoteObjectCode: string
Title:
Note ObjectThe Export Object Code for which Note has to be exported. -
NotificationEMail: string
Title:
Notification EmailMaximum Length:500The email ID to which the export job status emails are sent. -
PrivateMap: string
Private maps are persistant and can only be viewed or deleted by the owner.
-
RecordsExported: string
Title:
Records ExportedRead Only:trueThe total number of records exported. -
RestNotification: string
Specifies the REST Endpoint name, to which the notification will be sent after completion of the export job.
-
SplitSize: integer
(int64)
Title:
Split SizeSpecifies the split size when split is enabled. You can specify the split size in multiples of 100000 records. The default value is 100000. -
StartTm: string
Title:
Start TimeRead Only:trueThe time at which the export job begins. -
Status: string
Title:
StatusMaximum Length:30Default Value:NEWThe status of the export job. -
TimestampFormat: string
Title:
Time Stamp FormatMaximum Length:120Default Value:ORA_ZCA_US_FORMATThe format of the time stamp values in the exported file.
Nested Schema : Export Attachments
Type:
arrayTitle:
Export AttachmentsThe attachment resource is used to export attachments for an object.
Show Source
Nested Schema : Export Child Object Activities
Type:
arrayTitle:
Export Child Object ActivitiesThe export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : bulkExportActivities-Attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdThe unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name of the person who uploaded the attachment. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the attachment record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEThe code indicating the data type. A list of valid values is defined in the lookup WEB_PAGE. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URL of the attached file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name of the person who last updated the attachment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name of the attachment file. -
UploadedText: string
Title:
Uploaded TextThe text of the attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of the attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of the attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login associated with the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : bulkExportActivities-childBulkExportActivity-item-response
Type:
Show Source
object-
childBulkExportActivity: array
Export Child Object Activities
Title:
Export Child Object ActivitiesThe export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the record was created. -
ExportColumnNames: string
Title:
Export Column NamesThe object columns that are exported. -
ExportFilterCriteria: string
Title:
Export Filter CriteriaMaximum Length:4000The export object filter criteria specifying which records will be exported. -
ExportObject: string
Title:
Object CodeMaximum Length:128The name of the object that is exported. -
ExportOrderBy: string
Title:
Order ByMaximum Length:1000The order of the columns in the exported file. -
ExportParentObject: string
Title:
Export Parent ObjectMaximum Length:128The name of the parent object that is exported. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login of the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
RecordsExported: string
Title:
Records ExportedRead Only:trueThe total number of records exported.
Nested Schema : Export Child Object Activities
Type:
arrayTitle:
Export Child Object ActivitiesThe export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the record was created. -
ExportColumnNames: string
Title:
Export Column NamesThe object columns that are exported. -
ExportFilterCriteria: string
Title:
Export Filter CriteriaMaximum Length:4000The export object filter criteria specifying which records will be exported. -
ExportObject: string
Title:
Object CodeMaximum Length:128The name of the object that is exported. -
ExportOrderBy: string
Title:
Order ByMaximum Length:1000The order of the columns in the exported file. -
ExportParentObject: string
Title:
Export Parent ObjectMaximum Length:128The name of the parent object that is exported. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login of the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
RecordsExported: string
Title:
Records ExportedRead Only:trueThe total number of records exported.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- ActivateLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DFA_YESNO
The list of valid values to activate a bulk export activity.
The following properties are defined on the LOV link relation:- Source Attribute: Activate; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- Attachments
-
Operation: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/AttachmentsParameters:
- BulkExportJobId:
$request.path.BulkExportJobId
The attachment resource is used to export attachments for an object. - BulkExportJobId:
- DateFormatLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_FILEIMPORT_DATE_FORMAT
The list of valid date formats that can be used while exporting.
The following properties are defined on the LOV link relation:- Source Attribute: DateFormat; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- DelimiterLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_IMPORT_FILE_DELIMITER
The list of values that can be used as a delimiter between different values in the exported file.
The following properties are defined on the LOV link relation:- Source Attribute: Delimiter; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- StatusLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZCA_EXP_JOB_STATUS
The list of valid statuses for a bulk export activity.
The following properties are defined on the LOV link relation:- Source Attribute: Status; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TimeStampformatLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_IMPORT_DATETIME_FORMAT
The following properties are defined on the LOV link relation:- Source Attribute: TimestampFormat; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- childBulkExportActivity
-
Parameters:
- BulkExportJobId:
$request.path.BulkExportJobId
The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels. - BulkExportJobId:
Examples
The following example shows how to create a bulk export activity by submitting a POST request on the REST resource using cURL.
Note:
Depending on the object being exported, you can export hierarchy trees with multiple levels using the bulk export activities resource. Using this resource, you can export the complete hierarchy, including multiple levels of hierarchical children, recursively within the parent object.cURL Command
curl -u <username:password> \ -X POST -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities
Example of Request Body
The following shows an example of the request body in JSON format.
{
"Name": "Account_Export_Test_hier",
"ExportObject": "Account",
"ExportColumnNames": "EmailAddress,PartyStatus,PartyNumber,OrganizationName",
"ExportFilterCriteria": "OrganizationName = '<acc_name>'",
"ExportFileName": "test_Acc_hier.zip",
"Activate": "YES",
"childBulkExportActivity": [
{
"ExportObject": "Address",
"ExportParentObject": "Account",
"ExportColumnNames": "City,Country,State,Status"
},
{
"ExportObject": "Classification",
"ExportParentObject": "Account",
"ExportColumnNames": "Status,PartyType,PrimaryFlag,ClassCategory,ClassCode"
}
]
}Example of Response Body
The following shows an example of the response body in JSON format.
{
"BulkExportJobId" : 300100125909014,
"Name" : "Account_Export_Test_hier",
"Description" : null,
"ExportObject" : "Account",
"ExportColumnNames" : "EmailAddress,PartyStatus,PartyNumber,OrganizationName",
"ExportFilterCriteria" : "OrganizationName = '<acc_name>'",
"ExportOrderBy" : null,
"ExportFileName" : "test_Acc_hier.zip",
"Status" : "QUEUED",
"Activate" : "YES",
"LangIndependentHeader": "NO",
"DateFormat": "ORA_ZCA_UK_CANADA_FORMAT",
"TimestampFormat": "ORA_ZCA_EUROPE_FORMAT",
"Delimiter" : "COMMA_DELIMITER",
"RecordsExported" : null,
"ExportFileURL" : null,
"ErrorReportFileURL" : null,
"NotificationEMail" : null,
"FileCharset" : "ORA_ZCA_UTF8_ENCODING",
"CreatedBy" : "SALES_ADMIN",
"CreationDate" : "2018-03-30T11:43:02+00:00",
"LastUpdateDate" : "2018-03-30T11:43:02.256+00:00",
"LastUpdatedBy" : "SALES_ADMIN",
"LastUpdateLogin" : "689BEC0A92A086F7E053C30AF20A2CDF",
"childBulkExportActivity" : [ {
"ExportObject" : "Address",
"ExportParentObject" : "Account",
"ExportColumnNames" : "City,Country,State,Status",
"ExportFilterCriteria" : null,
"ExportOrderBy" : null,
"RecordsExported" : "",
"CreatedBy" : "SALES_ADMIN",
"CreationDate" : "2018-04-05T09:02:36.331+00:00",
"LastUpdateDate" : "2018-04-05T09:02:36.373+00:00",
"LastUpdateLogin" : "6896C1B8A0EA1613E053D710F50AD3C3",
"LastUpdatedBy" : "SALES_ADMIN",
"links" : [ {
...,
} ]},
{
"ExportObject" : "Classification",
"ExportParentObject" : "Account",
"ExportColumnNames" : "Status,PartyType,PrimaryFlag,ClassCategory,ClassCode",
"ExportFilterCriteria" : null,
"ExportOrderBy" : null,
"RecordsExported" : "",
"CreatedBy" : "SALES_ADMIN",
"CreationDate" : "2018-04-05T09:02:36.399+00:00",
"LastUpdateDate" : "2018-04-05T09:02:36.433+00:00",
"LastUpdateLogin" : "6896C1B8A0EA1613E053D710F50AD3C3",
"LastUpdatedBy" : "SALES_ADMIN",
"links": [{
...,
}]
}],
"links" :
[ { ...,
}]
}