Update a bulk export activity

patch

/crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}

Request

Path Parameters
Header Parameters
  • 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".
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Activate
    Default Value: NO
    The attribute that specifies whether to activate the export job or not. Once activated a job is queued for execution.
  • Export Attachments
    Title: Export Attachments
    The attachment resource is used to export attachments for an object.
  • Title: Export Job Identifier
    The unique identifier of the export job.
  • Used for canceling an export job through REST
  • Export Child Object Activities
    Title: Export Child Object Activities
    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.
  • Title: Date Format
    Maximum Length: 120
    Default Value: ORA_ZCA_US_FORMAT
    The format of the date values in the exported file.
  • Title: Delimiter
    Maximum Length: 30
    Default Value: COMMA_DELIMITER
    The delimiter used for the exported file.
  • Title: Description
    Maximum Length: 250
    The description for the export job that is provided by the user.
  • Title: Export attachments
    Maximum Length: 20
    Default Value: NO
    Enables export of Attachments
  • Title: Enable Split
    Maximum Length: 20
    Default Value: NO
    Specifies 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.
  • Title: Error File URL
    The 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.
  • Title: Escape Special Characters
    Indicates whether to exclude any special characters like quotes, delimiter, new line and so on. The default value is false.
  • Title: Export Column Names
    The object columns that are exported.
  • Title: Export File Name
    Maximum Length: 250
    The name of the exported file that is uploaded to the file repository.
  • Title: Export File URL
    The URL used for downloading the export file in a browser. For programmatic download of the exported zip file contents, follow the /enclosure/ExportFileContents link.
  • Title: Export Filter Criteria
    Maximum Length: 4000
    The export object filter criteria specifying which records will be exported.
  • Title: Export Mapping
    A previously defined object filter criteria and mapping which specifies the list of records that will be exported.
  • Title: Object Code
    Maximum Length: 128
    The name of the object that is exported.
  • Title: Order By
    Maximum Length: 1000
    The order of the columns in the exported file.
  • Title: File Encoding
    Maximum Length: 30
    Default Value: ORA_ZCA_UTF8_ENCODING
    The format in which the characters within your export file are encoded.
  • Title: Enable Round Trip
    The language independent header for the exported file that is used to enable the round trip of job and automatic mapping.
  • Title: Name
    Maximum Length: 100
    The name provided for each individual export job.
  • Title: Note Object
    The Export Object Code for which Note has to be exported.
  • Title: Notification Email
    Maximum Length: 500
    The email ID to which the export job status emails are sent.
  • Specifies the REST Endpoint name, to which the notification will be sent after completion of the export job.
  • Title: Split Size
    Specifies the split size when split is enabled. You can specify the split size in multiples of 100000 records. The default value is 100000.
  • Title: Status
    Maximum Length: 30
    Default Value: NEW
    The status of the export job.
  • Title: Time Stamp Format
    Maximum Length: 120
    Default Value: ORA_ZCA_US_FORMAT
    The format of the time stamp values in the exported file.
Nested Schema : Export Attachments
Type: array
Title: Export Attachments
The attachment resource is used to export attachments for an object.
Show Source
Nested Schema : Export Child Object Activities
Type: array
Title: Export Child Object Activities
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.
Show Source
Nested Schema : bulkExportActivities-Attachments-item-patch-request
Type: object
Show Source
Nested Schema : bulkExportActivities-childBulkExportActivity-item-patch-request
Type: object
Show Source
Nested Schema : Export Child Object Activities
Type: array
Title: Export Child Object Activities
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.
Show Source
Nested Schema : bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : bulkExportActivities-item-response
Type: object
Show Source
  • Title: Activate
    Default Value: NO
    The attribute that specifies whether to activate the export job or not. Once activated a job is queued for execution.
  • Export Attachments
    Title: Export Attachments
    The attachment resource is used to export attachments for an object.
  • Title: Export Job Identifier
    The unique identifier of the export job.
  • Used for canceling an export job through REST
  • Read Only: true
    Indicates User who canceled export job
  • Export Child Object Activities
    Title: Export Child Object Activities
    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.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Read Only: true
    Specifies current logged in user
  • Title: Date Format
    Maximum Length: 120
    Default Value: ORA_ZCA_US_FORMAT
    The format of the date values in the exported file.
  • Title: Delimiter
    Maximum Length: 30
    Default Value: COMMA_DELIMITER
    The delimiter used for the exported file.
  • Title: Description
    Maximum Length: 250
    The description for the export job that is provided by the user.
  • Title: Export attachments
    Maximum Length: 20
    Default Value: NO
    Enables export of Attachments
  • Title: Enable Split
    Maximum Length: 20
    Default Value: NO
    Specifies 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.
  • Title: End Time
    Read Only: true
    The time at which the export job ends.
  • Read Only: true
    The contents of the attached export error file.
  • Title: Error File URL
    The 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.
  • Title: Escape Special Characters
    Indicates whether to exclude any special characters like quotes, delimiter, new line and so on. The default value is false.
  • Title: Export Column Names
    The object columns that are exported.
  • Read Only: true
    The contents of the attached export file.
  • Title: Export File Name
    Maximum Length: 250
    The name of the exported file that is uploaded to the file repository.
  • Title: Export File URL
    The URL used for downloading the export file in a browser. For programmatic download of the exported zip file contents, follow the /enclosure/ExportFileContents link.
  • Title: Export Filter Criteria
    Maximum Length: 4000
    The export object filter criteria specifying which records will be exported.
  • Title: Export Mapping
    A previously defined object filter criteria and mapping which specifies the list of records that will be exported.
  • Title: Object Code
    Maximum Length: 128
    The name of the object that is exported.
  • Title: Order By
    Maximum Length: 1000
    The order of the columns in the exported file.
  • Title: File Encoding
    Maximum Length: 30
    Default Value: ORA_ZCA_UTF8_ENCODING
    The format in which the characters within your export file are encoded.
  • Title: Enable Round Trip
    The language independent header for the exported file that is used to enable the round trip of job and automatic mapping.
  • Title: Last Update Date
    Read Only: true
    The date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Name
    Maximum Length: 100
    The name provided for each individual export job.
  • Title: Note Object
    The Export Object Code for which Note has to be exported.
  • Title: Notification Email
    Maximum Length: 500
    The email ID to which the export job status emails are sent.
  • Private maps are persistant and can only be viewed or deleted by the owner.
  • Title: Records Exported
    Read Only: true
    The total number of records exported.
  • Specifies the REST Endpoint name, to which the notification will be sent after completion of the export job.
  • Title: Split Size
    Specifies the split size when split is enabled. You can specify the split size in multiples of 100000 records. The default value is 100000.
  • Title: Start Time
    Read Only: true
    The time at which the export job begins.
  • Title: Status
    Maximum Length: 30
    Default Value: NEW
    The status of the export job.
  • Title: Time Stamp Format
    Maximum Length: 120
    Default Value: ORA_ZCA_US_FORMAT
    The format of the time stamp values in the exported file.
Nested Schema : Export Attachments
Type: array
Title: Export Attachments
The attachment resource is used to export attachments for an object.
Show Source
Nested Schema : Export Child Object Activities
Type: array
Title: Export Child Object Activities
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.
Show Source
Nested Schema : bulkExportActivities-Attachments-item-response
Type: object
Show Source
Nested Schema : bulkExportActivities-childBulkExportActivity-item-response
Type: object
Show Source
Nested Schema : Export Child Object Activities
Type: array
Title: Export Child Object Activities
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.
Show Source
Nested Schema : bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to update a bulk export activity by submitting a PATCH 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 PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100124395702

Example of Request Body

The following shows an example of the request body in JSON format.

{
  "Name": "RESTOPTYEXPORT",
  "Description": "The export activity",
  "Activate": "YES"
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "items" : [ {
	"BulkExportJobId" : 300100125069284,
    "Name" : "RESTOPTYEXPORT",
    "Description" : "The export activity",
    "ExportObject" : "Activity",
    "ExportColumnNames" : "ActivityNumber:Activity_num,Subject,ActivityStartDate:Start_Date,ActivityEndDate:End_Date,ActivityDescription:Description,ActivityFunctionCode:Activity,LeadId:Lead",
    "ExportFilterCriteria" : "ActivityFunctionCode='APPOINTMENT'",
  	"ExportOrderBy" : null,
    "ExportFileName" : "TestActivity.zip",
    "Status" : "COMPLETE",
    "Activate" : "YES",
    "DateFormat" : "ORA_ZCA_US_FORMAT",
    "TimestampFormat" : "ORA_ZCA_US_FORMAT",
    "Delimiter" : "COMMA_DELIMITER",
    "RecordsExported" : "1372",
	"ExportFileURL" : "https://servername.fa.us2.oraclecloud.com
/crmUI/content/conn/FusionAppsContentRepository/uuid/dDocID%3a7249?XFND_SCHEME_ID=1&XFND_CERT_FP=640016A4FFF44F2DDB164BFD4AF4FCDF73FEA5A8&XFND_RANDOM=7969084426093509287&XFND_EXPIRES=1522408109289&XFND_SIGNATURE=nYC2NRiKOAm-3WJz4OtPby-zEcGhkzCgfC1FhYoN5lF2pGisQnmJGqMM3CTGb21NgobT3dawoFlqUgrLZxcJ9vwvm35dnABgiC9NqOJBWu2HagFVYfu6rbSuCP1bbmKQw56yTm0KiV55t8n8JSeGx8v9Rmhw~ndm51ejEXTPPAVi00~rXwU3hB4QOrjR24qSUIxrtoZLnBv~RPkd6tzzufFs~-gqx0NC-VPOGlWp4i2wJyPOApd5to--id7xCbX6cl-JbTmYJbuz8zY5sw-PtzhK1x7bkq68NdJxX6i-SZDAc00BP2JE6ZN0VRyHlvPMan1a416AJnutElMajOujng__&Id=7249&download",
	"ErrorReportFileURL" : null,
    "NotificationEMail" : null,
    "FileCharset" : "ORA_ZCA_UTF8_ENCODING",
    "CreatedBy" : "SALES_ADMIN",
    "CreationDate" : "2018-03-29T13:12:40+00:00",
    "LastUpdateDate" : "2018-03-29T13:18:27+00:00",
    "LastUpdatedBy" : "SALES_ADMIN",
    "LastUpdateLogin" : "688D605C77836C4EE053C30AF20A932B",
    "links" :
	 ...,
	}
Back to Top