Create a file import activity data file
post
/crmRestApi/resources/11.13.18.05/importActivities/{ImportActivityId}/child/DataFiles
Request
Path Parameters
-
ImportActivityId(required): integer(int64)
The unique identifier that represents an import activity.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
FileName: string
Title:
File Name
Maximum Length:150
The name for the source CSV file. -
InputFileContentId: string
Title:
Source File Content ID
Maximum Length:150
The unique identifier of the UCM Content for the source CSV file. -
MessageCode: string
Maximum Length:
100
Indicates the Message Code related to import job.
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 : importActivities-DataFiles-item-response
Type:
Show Source
object
-
CanceledBy: string
Read Only:
true
Indicates the user who canceled the import job. -
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. -
Description: string
Title:
Description
Read Only:true
The description of the import job. -
EndTime: string
(date-time)
Title:
End Time
Read Only:true
The date and time when the processing of the source data file ends. -
ErrorReportContentId: string
Title:
Error File Content ID
Read Only:true
The unique identifier of the error report file. -
ErrorsReported: string
Title:
Records with Errors
Read Only:true
Maximum Length:150
The number of import records read from the source CSV file. -
EstimatedCompletionTime: string
Title:
Estimated Completion Time
Read Only:true
Maximum Length:150
The approximate time that it will take to process the source CSV file import. -
ExceptionReportContentId: string
Title:
Exception File Content ID
Read Only:true
The unique identifier of the exception report file. -
FileName: string
Title:
File Name
Maximum Length:150
The name for the source CSV file. -
InputFileContentId: string
Title:
Source File Content ID
Maximum Length:150
The unique identifier of the UCM Content for the source CSV file. -
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
Title:
Last Updated
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. -
LoadedSuccessfully: string
Title:
Successfully Loaded
Read Only:true
Maximum Length:150
The number of import records successfully loaded from the source CSV file. -
MessageCode: string
Maximum Length:
100
Indicates the Message Code related to import job. -
ReadFromFile: string
Title:
Total Records
Read Only:true
Maximum Length:150
The number of import records read from the source CSV file. -
Size: string
Title:
File Size
Read Only:true
The file size for the source CSV file. -
StartTime: string
(date-time)
Title:
Start Time
Read Only:true
The date and time when the processing of the source data file begins. -
Status: string
Title:
Status
Read Only:true
The current status of the source CSV file import processing. -
SuccessReportContentId: string
Title:
Success File Content ID
Read Only:true
The unique identifier of the success report file that is generated when the import is successfully completed. -
Title: string
Title:
Title
Read Only:true
The file name title for the source CSV file. -
Unprocessed: string
Read Only:
true
This field is to show unprocessed record count for a cancelled job -
Warnings: string
Title:
Records with Warnings
Read Only:true
Maximum Length:150
The number of import records processed from the source CSV file, which resulted in warning.
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
- DataFilesStatusVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKT_IMPORT_SCHEDULE_STATUS
The list of valid statuses for an import activity data file.
The following properties are defined on the LOV link relation:- Source Attribute: Status; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
Examples
The following example shows how to create a file import activity data file by submitting a POST request on the REST resource using cURL.
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/importActivities/300100139995470/child/DataFiles
Example of Request Body
The following shows an example of the request body in JSON format.
{ "InputFileContentId": "UCMFA00007278" }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "FileName" : null, "Title" : null, "Size" : null, "Description" : "User provided input data file", "InputFileContentId" : "UCMFA00007278", "StartTime" : null, "EndTime" : null, "EstimatedCompletionTime" : null, "Status" : "ORA_MKT_QUEUED", "ReadFromFile" : null, "LoadedSuccessfully" : null, "SuccessReportContentId" : null, "ErrorsReported" : null, "Warnings" : null, "ErrorReportContentId" : null, "ExceptionReportContentId" : null, "CreatedBy" : "SALES_ADMIN", "CreationDate" : "2017-11-03T05:15:16+00:00", "LastUpdateDate" : "2017-11-03T05:15:16.076+00:00", "LastUpdateLogin" : "5D0B0B6EB0A51FF9E05309C5F20A3696", "LastUpdatedBy" : "SALES_ADMIN", "links" : ... }