Jump to

• Request
• Response
• Examples

Get all file import activities

get

/crmRestApi/resources/11.13.18.05/importActivities

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • FileImportObjectActivityFinder: Finds a file import activity for the specified object name.
    Finder Variables:
    • ObjectCode; string; The unique object code for a file import object.
  • ImportActivityFinder: Finds a file import activity for the specified import activity ID.
    Finder Variables:
  • PrimaryKey: Finds the import activity by the primary key ImportActivityId.
    Finder Variables:
    • ImportActivityId; integer; The unique value to identify Import Activity.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Activate; string; 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; 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; The user who created the record.
  • CreationDate; string; The date and time when the record was created.
  • DateFormat; string; The date format used in the source file.
  • DecimalSeparator; string; The character used as a decimal separator for the numeric fields in the source file.
  • Delimiter; string; The delimiter used as data separator for the records in the source file.
  • Description; string; The description of the import job.
  • EnableCustomBusinessLogic; string; Enables the execution of custom business logic defined using Application Composer.
  • FileEncoding; string; The file encoding format applied for the import activity.
  • HighVolume; string; Indicates whether the import activity is classified as a high-volume import.
  • ImportActivityId; integer; The unique identifier that represents an import activity.
  • ImportMapping; string; The mapping number for a previously defined attribute mapping. Either the mapping number or the object code is required.
  • ImportMode; string; 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; The date and time when the record was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the record.
  • LastUpdatedBy; string; The user who last updated the record.
  • Name; string; The name of the import job.
  • NoteObjectCode; string; The code indicating the object for which the Note is being added, such as Account, Contact, or Opportunity.
  • NotificationEmail; string; The email of administrator who should be notified if the import error threshold is exceeded.
  • ObjectCode; string; 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; The schedule set for the import job determining whether it executes immediately ,or at a future date.
  • ScheduleTime; string; The date when an import activity job is scheduled.
  • TimestampFormat; string; The time stamp format for the import activity.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  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: string
  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 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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/importActivities-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object importActivities-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/importActivities-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-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":{
        "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
        },
        "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
        },
        "Cancel":{
            "type":"string",
            "description":"This attribute is for cancelling an import job using REST",
            "nullable":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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "Description":{
            "title":"Description",
            "maxLength":250,
            "type":"string",
            "description":"The description of the import job.",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the import job.",
            "nullable":false,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "ScheduleTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The date when an import activity job is scheduled.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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":{
        "CanceledBy":{
            "type":"string",
            "description":"Indicates the user who canceled the import job.",
            "nullable":true,
            "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
        },
        "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
        },
        "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
        },
        "ErrorReportContentId":{
            "title":"Error File Content ID",
            "type":"string",
            "description":"The unique identifier of the error report file.",
            "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
        },
        "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
        },
        "ExceptionReportContentId":{
            "title":"Exception File Content ID",
            "type":"string",
            "description":"The unique identifier of the exception report 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
        },
        "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
        },
        "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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "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
        },
        "MessageCode":{
            "maxLength":100,
            "type":"string",
            "description":"Indicates the Message Code related to import job.",
            "nullable":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
        },
        "Size":{
            "title":"File Size",
            "type":"string",
            "description":"The file size for the source CSV 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
        },
        "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
        },
        "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
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The file name title for 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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Back to Top

Examples

The following example shows how to get all file import activities 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

Example of Response Body

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

{
 "items" : [ 
	{
    "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" : 
	...
	},
	{
 	 "ImportActivityId" : 300100123779003,
    "Name" : "Sales team Member import 3",
    "Description" : null,
    "ObjectCode" : "SalesTeamMember",
    "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" : "300100123779010",
    "Schedule" : "ONE_TIME_IMMEDIATE",
    "ScheduleTime" : null,
    "Activate" : "YES",
    "CreatedBy" : "MHoope",
    "CreationDate" : "2017-11-02T14:28:18+00:00",
    "LastUpdateDate" : "2017-11-02T14:31:40+00:00",
    "LastUpdatedBy" : "MHoope",
    "LastUpdateLogin" : "5D00FDB705936AC0E053768DF50A8B0F",
    "HighVolume" : "NO",
	  "links" :
	...
	}
	],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": 
  ...
  }

Back to Top