Get a bulk export activity
get
/crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}
Request
Path Parameters
-
BulkExportJobId(required): integer(int64)
The unique identifier of the export job.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
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.
There's no request body for this operation.
Back to TopResponse
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:
Activate
Default Value:NO
The 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 Attachments
The attachment resource is used to export attachments for an object. -
BulkExportJobId: integer
(int64)
Title:
Export Job Identifier
The unique identifier of the export job. -
Cancel: string
Used for canceling an export job through REST
-
CanceledBy: string
Read Only:
true
Indicates User who canceled export job -
childBulkExportActivity: array
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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
CurrentLoggedInUser: string
Read Only:
true
Specifies current logged in user -
DateFormat: string
Title:
Date Format
Maximum Length:120
Default Value:ORA_ZCA_US_FORMAT
The format of the date values in the exported file. -
Delimiter: string
Title:
Delimiter
Maximum Length:30
Default Value:COMMA_DELIMITER
The delimiter used for the exported file. -
Description: string
Title:
Description
Maximum Length:250
The description for the export job that is provided by the user. -
EnableExportAttachment: string
Title:
Export attachments
Maximum Length:20
Default Value:NO
Enables export of Attachments -
EnableSplit: string
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. -
EndTm: string
Title:
End Time
Read Only:true
The time at which the export job ends. -
ErrorReportFileContents: string
(byte)
Read Only:
true
The contents of the attached export error file. -
ErrorReportFileURL: string
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. -
EscapeSpecialCharactersFlag: boolean
Title:
Escape Special Characters
Indicates whether to exclude any special characters like quotes, delimiter, new line and so on. The default value is false. -
ExportColumnNames: string
Title:
Export Column Names
The object columns that are exported. -
ExportFileContents: string
(byte)
Read Only:
true
The contents of the attached export file. -
ExportFileName: string
Title:
Export File Name
Maximum Length:250
The name of the exported file that is uploaded to the file repository. -
ExportFileURL: string
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. -
ExportFilterCriteria: string
Title:
Export Filter Criteria
Maximum Length:4000
The export object filter criteria specifying which records will be exported. -
ExportMapping: string
Title:
Export Mapping
A previously defined object filter criteria and mapping which specifies the list of records that will be exported. -
ExportObject: string
Title:
Object Code
Maximum Length:128
The name of the object that is exported. -
ExportOrderBy: string
Title:
Order By
Maximum Length:1000
The order of the columns in the exported file. -
FileCharset: string
Title:
File Encoding
Maximum Length:30
Default Value:ORA_ZCA_UTF8_ENCODING
The format in which the characters within your export file are encoded. -
LangIndependentHeader: string
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. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:100
The name provided for each individual export job. -
NoteObjectCode: string
Title:
Note Object
The Export Object Code for which Note has to be exported. -
NotificationEMail: string
Title:
Notification Email
Maximum Length:500
The 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 Exported
Read Only:true
The 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 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. -
StartTm: string
Title:
Start Time
Read Only:true
The time at which the export job begins. -
Status: string
Title:
Status
Maximum Length:30
Default Value:NEW
The status of the export job. -
TimestampFormat: string
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 : Links
Type:
array
Title:
Links
The 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 Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the person who uploaded the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the data type. A list of valid values is defined in the lookup WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attached file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name of the person who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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 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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
ExportColumnNames: string
Title:
Export Column Names
The object columns that are exported. -
ExportFilterCriteria: string
Title:
Export Filter Criteria
Maximum Length:4000
The export object filter criteria specifying which records will be exported. -
ExportObject: string
Title:
Object Code
Maximum Length:128
The name of the object that is exported. -
ExportOrderBy: string
Title:
Order By
Maximum Length:1000
The order of the columns in the exported file. -
ExportParentObject: string
Title:
Export Parent Object
Maximum Length:128
The name of the parent object that is exported. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RecordsExported: string
Title:
Records Exported
Read Only:true
The total number of records exported.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
ExportColumnNames: string
Title:
Export Column Names
The object columns that are exported. -
ExportFilterCriteria: string
Title:
Export Filter Criteria
Maximum Length:4000
The export object filter criteria specifying which records will be exported. -
ExportObject: string
Title:
Object Code
Maximum Length:128
The name of the object that is exported. -
ExportOrderBy: string
Title:
Order By
Maximum Length:1000
The order of the columns in the exported file. -
ExportParentObject: string
Title:
Export Parent Object
Maximum Length:128
The name of the parent object that is exported. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RecordsExported: string
Title:
Records Exported
Read Only:true
The total number of records exported.
Nested Schema : Links
Type:
array
Title:
Links
The 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 get a bulk export activity by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X
https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}
Example of Response Body
The following shows an example of the response body in JSON format.
{ "BulkExportJobId": 300100183509438, "Name": "Acct_Export", "Description": null, "ExportObject": "Account", "ExportMapping": "null", "ExportColumnNames": "EmailContactPointType,EmailAddress,WebContactPointType,URL,PartyNumberKey,AddressNumber,Country,PartyId,PartyNumber,OrganizationProfileId,OrganizationName,PartyUniqueName,SalesProfileNumber,OwnerPartyNumber,OwnerName,PartyType,CreatedBy,CreationDate,LastUpdateDate,LastUpdatedBy,PhoneContactPointType,FaxContactPointType", "ExportFilterCriteria": "OrganizationName IS NOT NULL", "ExportOrderBy": null, "ExportFileName": "Account20190927_1103.zip", "Status": "COMPLETE", "Activate": "YES", "DateFormat": "ORA_ZCA_US_FORMAT", "TimestampFormat": "ORA_ZCA_US_FORMAT", "Delimiter": "COMMA_DELIMITER", "EscapeSpecialCharactersFlag": "false", "RecordsExported": "", "ExportFileURL": "FUSION doesn't have access to this file. (ZCA-210338)", "ErrorReportFileURL": "FUSION doesn't have access to this file. (ZCA-210338)", "NotificationEMail": null, "FileCharset": "ORA_ZCA_UTF8_ENCODING", "CreatedBy": "MHoope", "CreationDate": "2019-09-27T11:03:08+00:00", "LastUpdateDate": "2019-09-27T11:09:48+00:00", "LastUpdatedBy": "MHoope", "LastUpdateLogin": "9386952CF31776BCE053A15AF00A09EE", "StartTm": null, "EndTm": null, "LangIndependentHeader": "NO", "NoteObjectCode": null, "EnableSplit": "NO", "SplitSize": 100000, "EnableExportAttachment": null, "CurrentLoggedInUser": "FUSION", "RestNotification": null, "Cancel": null, "CanceledBy": null, "PrivateMap": "N", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438", "name": "bulkExportActivities", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000003770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000C7371007E0002000000017371007E00020000000378" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438", "name": "bulkExportActivities", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438/child/Attachments", "name": "Attachments", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438/child/childBulkExportActivity", "name": "childBulkExportActivity", "kind": "collection" }, { "rel": "enclosure", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438/enclosure/ExportFileContents", "name": "ExportFileContents", "kind": "other" }, { "rel": "enclosure", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438/enclosure/ErrorReportFileContents", "name": "ErrorReportFileContents", "kind": "other" } ] }