Get a file import activity
get
/crmRestApi/resources/11.13.18.05/importActivities/{ImportActivityId}
Request
Path Parameters
-
ImportActivityId(required): integer(int64)
The unique identifier that represents an import activity.
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 : importActivities-item-response
Type:
Show Source
object
-
Activate: string
Title:
Activate Import Job
Default Value:NO
Indicates whether the job should be activated. Possible values are Yes and No. If the value is Yes, then the import job is activated and the log files are created. If the value is No, then the import job is saved but not activated. -
AttachmentObjectCode: string
Title:
Attachment Object Code
The code indicating the object being attached, such as Account, Contact, or Opportunity. -
Cancel: string
This attribute is for cancelling an import job using REST
-
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. -
DataFiles: array
Import Activity Data Files
Title:
Import Activity Data Files
The import activity data files resource is used to view and create the data files that contain the information that is to be imported. -
DateFormat: string
Title:
Date Format
Maximum Length:120
Default Value:ORA_ZCA_US_FORMAT
The date format used in the source file. -
DecimalSeparator: string
Title:
Decimal Separator
Maximum Length:120
Default Value:.
The character used as a decimal separator for the numeric fields in the source file. -
Delimiter: string
Title:
Delimiter
Maximum Length:30
Default Value:COMMA_DELIMITER
The delimiter used as data separator for the records in the source file. -
Description: string
Title:
Description
Maximum Length:250
The description of the import job. -
EnableCustomBusinessLogic: string
Title:
Enable Custom Business Logic
Default Value:NO
Enables the execution of custom business logic defined using Application Composer. -
FileEncoding: string
Title:
File Encoding
Maximum Length:30
Default Value:ORA_ZCA_UTF8_ENCODING
The file encoding format applied for the import activity. -
HighVolume: string
Title:
High Volume
Default Value:NO
Indicates whether the import activity is classified as a high-volume import. -
ImportActivityId: integer
(int64)
Title:
Import Activity Identifier
The unique identifier that represents an import activity. -
ImportMapping: string
Title:
Mapping Number
The mapping number for a previously defined attribute mapping. Either the mapping number or the object code is required. -
ImportMode: string
Title:
Import Mode
Maximum Length:30
Default Value:CREATE_RECORD
The mode of import. Possible values are Create a new record, Update an existing record, or Delete an existing record. The values are CREATE_ONLY (Create Record), CREATE_RECORD ( Create and Update), DELETE_RECORD ( Delete). To update records in custom object, pass valid IDs in the csv. Only update isn't supported. -
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 of the import job. -
NoteObjectCode: string
Title:
Note Object
The code indicating the object for which the Note is being added, such as Account, Contact, or Opportunity. -
NotificationEmail: string
Title:
Notification Email
Maximum Length:500
The email of administrator who should be notified if the import error threshold is exceeded. -
ObjectCode: string
Title:
Object Code
Maximum Length:100
The code indicating the object being imported, such as Account, Contact, or Opportunity. -
RestNotification: string
Specifies the REST Resource name to which the notification will be sent after the completion of import job
-
Schedule: string
Title:
Schedule
Maximum Length:30
Default Value:ONE_TIME_IMMEDIATE
The schedule set for the import job determining whether it executes immediately ,or at a future date. -
ScheduleTime: string
(date-time)
Title:
Start Time
The date when an import activity job is scheduled. -
TimestampFormat: string
Title:
Time Stamp Format
Maximum Length:120
Default Value:ORA_ZCA_US_FORMAT
The time stamp format for the import activity.
Nested Schema : Import Activity Data Files
Type:
array
Title:
Import Activity Data Files
The import activity data files resource is used to view and create the data files that contain the information that is to be imported.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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
- DataFiles
-
Parameters:
- ImportActivityId:
$request.path.ImportActivityId
The import activity data files resource is used to view and create the data files that contain the information that is to be imported. - ImportActivityId:
- ImportAttachmentObjectsLOV
-
Parameters:
- finder:
attachmentObjectRowFinder
The list of values that specify whether the object supports attachments or not.
The following properties are defined on the LOV link relation:- Source Attribute: AttachmentObjectCode; Target Attribute: ObjectCode
- Display Attribute: DisplayName
- finder:
- ImportDataFormatLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_FILEIMPORT_DATE_FORMAT
The list of values that can be used as a valid format for date in the source CSV file.
The following properties are defined on the LOV link relation:- Source Attribute: DateFormat; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ImportDecimalSeparatorLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DDECIMAL_SEPARATOR
The list of values that can be used as a decimal separator in the source CSV file.
The following properties are defined on the LOV link relation:- Source Attribute: DecimalSeparator; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ImportDelimiterLOV
-
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 source CSV file.
The following properties are defined on the LOV link relation:- Source Attribute: Delimiter; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ImportFileEncodingLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_IMPORT_FILE_ENCODING
The list of values that represent the supported file encoding for the source CSV file.
The following properties are defined on the LOV link relation:- Source Attribute: FileEncoding; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ImportMappingsLOV
-
Parameters:
- finder:
ImportMapFinder
The list of import maps that are available for use.
The following properties are defined on the LOV link relation:- Source Attribute: ImportMapping; Target Attribute: MappingNumber
- Display Attribute: Name
- finder:
- ImportModeLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DIMPORT_MODE
The list of values for the import activity mode, which specify different operations like insert, upsert and delete.
The following properties are defined on the LOV link relation:- Source Attribute: ImportMode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ImportNoteObjectsLOV
-
Parameters:
- finder:
noteObjectRowFinder
The list of values that specify whether the object supports adding notes or not.
The following properties are defined on the LOV link relation:- Source Attribute: NoteObjectCode; Target Attribute: ObjectCode
- Display Attribute: DisplayName
- finder:
- ImportObjectsLOV
-
Parameters:
- finder:
objectRowFinder
The file import object list.
The following properties are defined on the LOV link relation:- Source Attribute: ObjectCode; Target Attribute: ObjectCode
- Display Attribute: DisplayName
- finder:
- ImportScheduleModeLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_IMPORT_SCHEDULE_MODE
The valid scheduling options for an import activity.
The following properties are defined on the LOV link relation:- Source Attribute: Schedule; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ImportTimeStampLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_IMPORT_DATETIME_FORMAT
The list of values that can be used as a valid format for a timestamp value in the source CSV file.
The following properties are defined on the LOV link relation:- Source Attribute: TimestampFormat; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- YESNOLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DFA_YESNO
The list of values that specify whether an import activity can execute custom business logic or not.
The following properties are defined on the LOV link relation:- Source Attribute: EnableCustomBusinessLogic; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
Examples
The following example shows how to get a file import activity by submitting a GET 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/300100123779027
Example of Response Body
The following shows an example of the response body in JSON format.
{ "ImportActivityId" : 300100123779027, "Name" : "Acc_MAT_delay_WarningLink", "Description" : null, "ObjectCode" : "Account", "AttachmentObjectCode" : null, "DecimalSeparator" : ".", "DateFormat" : "ORA_ZCA_US_FORMAT", "ImportMode" : "CREATE_RECORD", "TimestampFormat" : "ORA_ZCA_US_FORMAT", "FileEncoding" : "ORA_ZCA_UTF8_ENCODING", "Delimiter" : "COMMA_DELIMITER", "NotificationEmail" : null, "ImportMapping" : "300100123779030", "Schedule" : "ONE_TIME_IMMEDIATE", "ScheduleTime" : null, "Activate" : "YES", "CreatedBy" : "MHoope", "CreationDate" : "2017-11-02T14:30:43+00:00", "LastUpdateDate" : "2017-11-02T14:34:27+00:00", "LastUpdatedBy" : "MHoope", "LastUpdateLogin" : "5D00FDB705986AC0E053768DF50A8B0F", "HighVolume" : "NO", "links" : ... }