Jump to

• Request
• Response
• Examples

Create a file import activity

post

/crmRestApi/resources/11.13.18.05/importActivities

Request

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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
• 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.
• Name(required): 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.

{
    "required":[
        "Name"
    ],
    "type":"object",
    "properties":{
        "DecimalSeparator":{
            "title":"Decimal Separator",
            "maxLength":"120",
            "type":"string",
            "description":"The character used as a decimal separator for the numeric fields in the source file.",
            "nullable":true,
            "default":".",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EnableCustomBusinessLogic":{
            "title":"Enable Custom Business Logic",
            "type":"string",
            "description":"Enables the execution of custom business logic defined using Application Composer.",
            "nullable":true,
            "default":"NO",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NoteObjectCode":{
            "title":"Note Object",
            "type":"string",
            "description":"The code indicating the object for which the Note is being added, such as Account, Contact,  or Opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"250",
            "type":"string",
            "description":"The description of the import job.",
            "nullable":true
        },
        "Delimiter":{
            "title":"Delimiter",
            "maxLength":"30",
            "type":"string",
            "description":"The delimiter used as data separator for the records in the source file.",
            "nullable":true,
            "default":"COMMA_DELIMITER",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ImportMapping":{
            "title":"Mapping Number",
            "type":"string",
            "description":"The mapping number for a previously defined attribute mapping. Either the mapping number or the object code is required.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Cancel":{
            "type":"string",
            "description":"This attribute is for cancelling an import job using REST",
            "nullable":true
        },
        "ImportActivityId":{
            "title":"Import Activity Identifier",
            "type":"integer",
            "description":"The unique identifier that represents an import activity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttachmentObjectCode":{
            "title":"Attachment Object Code",
            "type":"string",
            "description":"The code indicating the object being attached, such as Account, Contact,  or Opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DataFiles":{
            "title":"Import Activity Data Files",
            "type":"array",
            "description":"The import activity data files resource is used to view and create the data files that contain the information that is to be imported.",
            "items":{
                "$ref":"#/components/schemas/importActivities-DataFiles-item-post-request"
            }
        },
        "TimestampFormat":{
            "title":"Time Stamp Format",
            "maxLength":"120",
            "type":"string",
            "description":"The time stamp format for the import activity.",
            "nullable":true,
            "default":"ORA_ZCA_US_FORMAT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":"100",
            "type":"string",
            "description":"The code indicating the object being imported, such as Account, Contact,  or Opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the import job.",
            "nullable":false
        },
        "RestNotification":{
            "type":"string",
            "description":"Specifies the REST Resource name to which the notification will be sent after the completion of import job",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NotificationEmail":{
            "title":"Notification Email",
            "maxLength":"500",
            "type":"string",
            "description":"The email of administrator who should be notified if the import error threshold is exceeded.",
            "nullable":true
        },
        "ImportMode":{
            "title":"Import Mode",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"CREATE_RECORD",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ScheduleTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The date when an import activity job is scheduled.",
            "format":"date-time",
            "nullable":true
        },
        "Activate":{
            "title":"Activate Import Job",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"NO",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "HighVolume":{
            "title":"High Volume",
            "type":"string",
            "description":"Indicates whether the import activity is classified as a high-volume import.",
            "nullable":true,
            "default":"NO",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DateFormat":{
            "title":"Date Format",
            "maxLength":"120",
            "type":"string",
            "description":"The date format used in the source file.",
            "nullable":true,
            "default":"ORA_ZCA_US_FORMAT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Schedule":{
            "title":"Schedule",
            "maxLength":"30",
            "type":"string",
            "description":"The schedule set for the import job determining whether it executes immediately ,or at a future date.",
            "nullable":true,
            "default":"ONE_TIME_IMMEDIATE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FileEncoding":{
            "title":"File Encoding",
            "maxLength":"30",
            "type":"string",
            "description":"The file encoding format applied for the import activity.",
            "nullable":true,
            "default":"ORA_ZCA_UTF8_ENCODING",
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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

• Array of: object importActivities-DataFiles-item-post-request

{
    "title":"Import Activity Data Files",
    "type":"array",
    "description":"The import activity data files resource is used to view and create the data files that contain the information that is to be imported.",
    "items":{
        "$ref":"#/components/schemas/importActivities-DataFiles-item-post-request"
    }
}

Nested Schema : importActivities-DataFiles-item-post-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "MessageCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Indicates the Message Code related to import job.",
            "nullable":true
        },
        "InputFileContentId":{
            "title":"Source File Content ID",
            "maxLength":"150",
            "type":"string",
            "description":"The unique identifier of the UCM Content for the source CSV file.",
            "nullable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name for the source CSV file.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : importActivities-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "EnableCustomBusinessLogic":{
            "title":"Enable Custom Business Logic",
            "type":"string",
            "description":"Enables the execution of custom business logic defined using Application Composer.",
            "nullable":true,
            "default":"NO",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteObjectCode":{
            "title":"Note Object",
            "type":"string",
            "description":"The code indicating the object for which the Note is being added, such as Account, Contact,  or Opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"250",
            "type":"string",
            "description":"The description of the import job.",
            "nullable":true,
            "x-queryable":true
        },
        "ImportMapping":{
            "title":"Mapping Number",
            "type":"string",
            "description":"The mapping number for a previously defined attribute mapping. Either the mapping number or the object code is required.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Cancel":{
            "type":"string",
            "description":"This attribute is for cancelling an import job using REST",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":"100",
            "type":"string",
            "description":"The code indicating the object being imported, such as Account, Contact,  or Opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the import job.",
            "nullable":false,
            "x-queryable":true
        },
        "HighVolume":{
            "title":"High Volume",
            "type":"string",
            "description":"Indicates whether the import activity is classified as a high-volume import.",
            "nullable":true,
            "default":"NO",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DecimalSeparator":{
            "title":"Decimal Separator",
            "maxLength":"120",
            "type":"string",
            "description":"The character used as a decimal separator for the numeric fields in the source file.",
            "nullable":true,
            "default":".",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Delimiter":{
            "title":"Delimiter",
            "maxLength":"30",
            "type":"string",
            "description":"The delimiter used as data separator for the records in the source file.",
            "nullable":true,
            "default":"COMMA_DELIMITER",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ImportActivityId":{
            "title":"Import Activity Identifier",
            "type":"integer",
            "description":"The unique identifier that represents an import activity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttachmentObjectCode":{
            "title":"Attachment Object Code",
            "type":"string",
            "description":"The code indicating the object being attached, such as Account, Contact,  or Opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DataFiles":{
            "title":"Import Activity Data Files",
            "type":"array",
            "description":"The import activity data files resource is used to view and create the data files that contain the information that is to be imported.",
            "items":{
                "$ref":"#/components/schemas/importActivities-DataFiles-item-response"
            }
        },
        "TimestampFormat":{
            "title":"Time Stamp Format",
            "maxLength":"120",
            "type":"string",
            "description":"The time stamp format for the import activity.",
            "nullable":true,
            "default":"ORA_ZCA_US_FORMAT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RestNotification":{
            "type":"string",
            "description":"Specifies the REST Resource name to which the notification will be sent after the completion of import job",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NotificationEmail":{
            "title":"Notification Email",
            "maxLength":"500",
            "type":"string",
            "description":"The email of administrator who should be notified if the import error threshold is exceeded.",
            "nullable":true,
            "x-queryable":true
        },
        "ImportMode":{
            "title":"Import Mode",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"CREATE_RECORD",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The date when an import activity job is scheduled.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Activate":{
            "title":"Activate Import Job",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"NO",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DateFormat":{
            "title":"Date Format",
            "maxLength":"120",
            "type":"string",
            "description":"The date format used in the source file.",
            "nullable":true,
            "default":"ORA_ZCA_US_FORMAT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Schedule":{
            "title":"Schedule",
            "maxLength":"30",
            "type":"string",
            "description":"The schedule set for the import job determining whether it executes immediately ,or at a future date.",
            "nullable":true,
            "default":"ONE_TIME_IMMEDIATE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FileEncoding":{
            "title":"File Encoding",
            "maxLength":"30",
            "type":"string",
            "description":"The file encoding format applied for the import activity.",
            "nullable":true,
            "default":"ORA_ZCA_UTF8_ENCODING",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object importActivities-DataFiles-item-response

{
    "title":"Import Activity Data Files",
    "type":"array",
    "description":"The import activity data files resource is used to view and create the data files that contain the information that is to be imported.",
    "items":{
        "$ref":"#/components/schemas/importActivities-DataFiles-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : importActivities-DataFiles-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"The description of the import job.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorsReported":{
            "title":"Records with Errors",
            "maxLength":"150",
            "type":"string",
            "description":"The number of import records read from the source CSV file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The date and time when the processing of the source data file ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Size":{
            "title":"File Size",
            "type":"string",
            "description":"The file size for the source CSV file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name for the source CSV file.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedCompletionTime":{
            "title":"Estimated Completion Time",
            "maxLength":"150",
            "type":"string",
            "description":"The approximate time that it will take to process the source CSV file import.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReadFromFile":{
            "title":"Total Records",
            "maxLength":"150",
            "type":"string",
            "description":"The number of import records read from the source CSV file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Unprocessed":{
            "type":"string",
            "description":"This field is to show  unprocessed record count for a cancelled job",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InputFileContentId":{
            "title":"Source File Content ID",
            "maxLength":"150",
            "type":"string",
            "description":"The unique identifier of the UCM Content for the source CSV file.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorReportContentId":{
            "title":"Error File Content ID",
            "type":"string",
            "description":"The unique identifier of the error report file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CanceledBy":{
            "type":"string",
            "description":"Indicates the user who canceled the import job.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LoadedSuccessfully":{
            "title":"Successfully Loaded",
            "maxLength":"150",
            "type":"string",
            "description":"The number of import records successfully loaded from the source CSV file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "type":"string",
            "description":"The current status of the source CSV file import processing.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Indicates the Message Code related to import job.",
            "nullable":true,
            "x-queryable":true
        },
        "ExceptionReportContentId":{
            "title":"Exception File Content ID",
            "type":"string",
            "description":"The unique identifier of the exception report file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The date and time when the processing of the source data file begins.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The file name title for the source CSV file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuccessReportContentId":{
            "title":"Success File Content ID",
            "type":"string",
            "description":"The unique identifier of the success report file that is generated when the import is successfully completed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Warnings":{
            "title":"Records with Warnings",
            "maxLength":"150",
            "type":"string",
            "description":"The number of import records processed from the source CSV file, which resulted in warning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

DataFiles

Operation: /crmRestApi/resources/11.13.18.05/importActivities/{ImportActivityId}/child/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.

ImportAttachmentObjectsLOV

Operation: /crmRestApi/resources/11.13.18.05/importExportObjectMetadata

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

ImportDataFormatLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

ImportDecimalSeparatorLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

ImportDelimiterLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

ImportFileEncodingLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

ImportMappingsLOV

Operation: /crmRestApi/resources/11.13.18.05/importMappings

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

ImportModeLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

ImportNoteObjectsLOV

Operation: /crmRestApi/resources/11.13.18.05/importExportObjectMetadata

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

ImportObjectsLOV

Operation: /crmRestApi/resources/11.13.18.05/importExportObjectMetadata

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

ImportScheduleModeLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

ImportTimeStampLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

YESNOLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

Back to Top

Examples

The following examples show the different methods of creating a file import activity by submitting a POST request on the REST resource using cURL.

Note:

You can set the Activate attribute to either activate or save the import job. If you set the attribute value to Yes, the job is activated and the log files are created. If you set the value to No, the import job is saved but not activated.

Create an Import Activity with Low Volume Import

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

Example of Request Body

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

{
      "Name": "RevDemo",
      "ImportMapping": "300100112335918",
      "Activate": "YES",
      "DataFiles" : [{
                   "InputFileContentId": "UCMFA00007278"
                    }]
}

Example of Response Body

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

{
  "ImportActivityId" : 300100123778226,
  "Name" : "RevDemo",
  "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" : 300100112335918,
  "Schedule" : "ONE_TIME_IMMEDIATE",
  "ScheduleTime" : null,
  "Activate" : "YES",
  "CreatedBy" : "SALES_ADMIN",
  "CreationDate" : "2017-11-02T15:12:33+00:00",
  "LastUpdateDate" : "2017-11-02T15:12:33.078+00:00",
  "LastUpdatedBy" : "SALES_ADMIN",
  "LastUpdateLogin" : "5D01E1EBD5EB6C3EE053768DF50A9500",
  "HighVolume" : "NO",
   "links" : 
	...
  }

Note:

To update records in custom object, pass valid IDs in the csv. Only update isn't supported.

Create an Import Activity with Automatic Mapping

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

Example of Request Body

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

{
      "Name": "RevDemo",
      "ObjectCode": "Account",
      "Activate": "YES",
      "HighVolume":"YES",/* this is optional */
      "DataFiles" : [{
                   "InputFileContentId": "UCMFA00007278"
                    }]
}

Example of Response Body

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

{
  "ImportActivityId" : 300100123778226,
  "Name" : "RevDemo",
  "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" : 300100112335918,
  "Schedule" : "ONE_TIME_IMMEDIATE",
  "ScheduleTime" : null,
  "Activate" : "YES",
  "CreatedBy" : "SALES_ADMIN",
  "CreationDate" : "2017-11-02T15:12:33+00:00",
  "LastUpdateDate" : "2017-11-02T15:12:33.078+00:00",
  "LastUpdatedBy" : "SALES_ADMIN",
  "LastUpdateLogin" : "5D01E1EBD5EB6C3EE053768DF50A9500",
  "HighVolume" : "YES",
   "links" : 
	...
 }

Create an Import Activity with Attachment Import

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

Example of Request Body

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

{
     "Name": "RevDemo",
     "ObjectCode": "Attachment",
	   "AttachmentObjectCode" : "Account",
     "Activate": "YES",
     "DataFiles" : [{
                   "InputFileContentId": "UCMFA00007278"
                    }]
}

Example of Response Body

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

{
  "ImportActivityId" : 300100123778226,
  "Name" : "RevDemo",
  "Description" : null,
  "ObjectCode" : "Attachment",
  "AttachmentObjectCode" : Account,
  "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" : 300100112335918,
  "Schedule" : "ONE_TIME_IMMEDIATE",
  "ScheduleTime" : null,
  "Activate" : "YES",
  "CreatedBy" : "SALES_ADMIN",
  "CreationDate" : "2017-11-02T15:12:33+00:00",
  "LastUpdateDate" : "2017-11-02T15:12:33.078+00:00",
  "LastUpdatedBy" : "SALES_ADMIN",
  "LastUpdateLogin" : "5D01E1EBD5EB6C3EE053768DF50A9500",
  "HighVolume" : "NO",
   "links" : 
	...
}

Create an Import Activity with Scheduling an Import

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

Example of Request Body

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

 {
      "Name": "RevDemo",
      "Schedule" : "ONE_TIME_SCHEDULE",
      "ScheduleTime" : "2017-05-17T00:00:00+00:00",
	    "ImportMapping" : "300100089944767",
	    "Activate": "YES",
      "DataFiles" : [{
                   "InputFileContentId": "UCMFA00007278"
                    }]
 }

Example of Response Body

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

{
  "ImportActivityId" : 300100123778226,
  "Name" : "RevDemo",
  "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" : 300100089944767,
  "Schedule" : "ONE_TIME_SCHEDULE",
  "ScheduleTime" : "2017-05-17T00:00:00+00:00",
  "Activate" : "YES",
  "CreatedBy" : "SALES_ADMIN",
  "CreationDate" : "2017-11-02T15:12:33+00:00",
  "LastUpdateDate" : "2017-11-02T15:12:33.078+00:00",
  "LastUpdatedBy" : "SALES_ADMIN",
  "LastUpdateLogin" : "5D01E1EBD5EB6C3EE053768DF50A9500",
  "HighVolume" : "NO",
   "links" : 
	...
}

Create an Import Activity with Multi File Import Pattern

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

Example of Request Body

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

 {
"Name": "RevDemo",
"ImportMapping" : "300100089944767",
"Activate": "YES",
"DataFiles" : [
		{"InputFileContentId": "UCMFA00007278"  },
		{"InputFileContentId" : "UCMFA00016242" }
		]
}

Example of Response Body

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

{
  "ImportActivityId" : 300100123778226,
  "Name" : "RevDemo",
  "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" : 300100089944767,
  "Schedule" : "ONE_TIME_IMMEDIATE",
  "ScheduleTime" : null,
  "Activate" : "YES",
  "CreatedBy" : "SALES_ADMIN",
  "CreationDate" : "2017-11-02T15:12:33+00:00",
  "LastUpdateDate" : "2017-11-02T15:12:33.078+00:00",
  "LastUpdatedBy" : "SALES_ADMIN",
  "LastUpdateLogin" : "5D01E1EBD5EB6C3EE053768DF50A9500",
  "HighVolume" : "NO",
   "links" : 
	...
}

Back to Top