Create a child bulk export activity
post
/crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/childBulkExportActivity
Request
Path Parameters
-
BulkExportJobId(required): integer(int64)
The unique identifier of the export job.
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.
-
Upsert-Mode:
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
-
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. -
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(required): 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.
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 : schema
Type:
Show Source
object
-
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.
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-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
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.
Links
- childBulkExportActivity
-
Parameters:
- BulkExportJobId:
$request.path.BulkExportJobId
- ExportObject:
$request.path.ExportObject
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 child object detail 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 child 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/300100125069284/child/childBulkExportActivity
Example of Request Body
The following shows an example of the request body in JSON format.
{ "ExportObject": "Address", "ExportParentObject": "Account", "ExportColumnNames" : "City,Country,State,Status" }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "ExportObject" : "Address", "ExportParentObject" : "Account", "ExportColumnNames" : "City,Country,State,Status", "ExportFilterCriteria" : null, "ExportOrderBy" : null, "RecordsExported" : null, "CreatedBy" : "SALES_ADMIN", "CreationDate" : "2018-03-30T13:48:39+00:00", "LastUpdateDate" : "2018-03-30T13:48:39.030+00:00", "LastUpdateLogin" : "68A0FCD07B4DF329E053C30AF20AC1AB", "LastUpdatedBy" : "SALES_ADMIN", "links" : ... }