1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Import Activities
  4. Import Activity Data Files

Get all file import activity data files

get

/crmRestApi/resources/11.13.18.05/importActivities/{ImportActivityId}/child/DataFiles

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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).
  • 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
  • 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:

    • FileImportDataFileFinder: Finds a file import activity data file with the specified content ID.
      Finder Variables:
      • InputFileContentId; string; The unique value to identify a data file content ID.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • CanceledBy; string; Indicates the user who canceled the import job.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date and time when the record was created.
    • Description; string; The description of the import job.
    • EndTime; string; The date and time when the processing of the source data file ends.
    • ErrorReportContentId; string; The unique identifier of the error report file.
    • ErrorsReported; string; The number of import records read from the source CSV file.
    • EstimatedCompletionTime; string; The approximate time that it will take to process the source CSV file import.
    • ExceptionReportContentId; string; The unique identifier of the exception report file.
    • FileName; string; The name for the source CSV file.
    • InputFileContentId; string; The unique identifier of the UCM Content for the source CSV file.
    • 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.
    • LoadedSuccessfully; string; The number of import records successfully loaded from the source CSV file.
    • MessageCode; string; Indicates the Message Code related to import job.
    • ReadFromFile; string; The number of import records read from the source CSV file.
    • Size; string; The file size for the source CSV file.
    • StartTime; string; The date and time when the processing of the source data file begins.
    • Status; string; The current status of the source CSV file import processing.
    • SuccessReportContentId; string; The unique identifier of the success report file that is generated when the import is successfully completed.
    • Title; string; The file name title for the source CSV file.
    • Unprocessed; string; This field is to show unprocessed record count for a cancelled job
    • Warnings; string; The number of import records processed from the source CSV file, which resulted in warning.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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-DataFiles
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : importActivities-DataFiles-item-response
Type: object
Show Source
  • Read Only: true
    Indicates the user who canceled the import job.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Title: Description
    Read Only: true
    The description of the import job.
  • Title: End Time
    Read Only: true
    The date and time when the processing of the source data file ends.
  • Title: Error File Content ID
    Read Only: true
    The unique identifier of the error report file.
  • Title: Records with Errors
    Read Only: true
    Maximum Length: 150
    The number of import records read from the source CSV file.
  • Title: Estimated Completion Time
    Read Only: true
    Maximum Length: 150
    The approximate time that it will take to process the source CSV file import.
  • Title: Exception File Content ID
    Read Only: true
    The unique identifier of the exception report file.
  • Title: File Name
    Maximum Length: 150
    The name for the source CSV file.
  • Title: Source File Content ID
    Maximum Length: 150
    The unique identifier of the UCM Content for the source CSV file.
  • Title: Last Update Date
    Read Only: true
    The date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Updated
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Successfully Loaded
    Read Only: true
    Maximum Length: 150
    The number of import records successfully loaded from the source CSV file.
  • Maximum Length: 100
    Indicates the Message Code related to import job.
  • Title: Total Records
    Read Only: true
    Maximum Length: 150
    The number of import records read from the source CSV file.
  • Title: File Size
    Read Only: true
    The file size for the source CSV file.
  • Title: Start Time
    Read Only: true
    The date and time when the processing of the source data file begins.
  • Title: Status
    Read Only: true
    The current status of the source CSV file import processing.
  • 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: Title
    Read Only: true
    The file name title for the source CSV file.
  • Read Only: true
    This field is to show unprocessed record count for a cancelled job
  • 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.
Back to Top

Examples

The following example shows how to get all file import activity data files by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/importActivities/300100123779027/child/DataFiles

Example of Response Body

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

{
  "items" : [ {
    "FileName" : "AccountCreateUpdate_Simple.csv",
    "Title" : "AccountCreateUpdate_Simple.csv",
    "Size" : "850 BYTES",
    "Description" : "User provided input data file",
    "InputFileContentId" : "UCMFA00004192",
    "StartTime" : "2017-11-02T14:31:56+00:00",
    "EndTime" : "2017-11-02T14:34:14+00:00",
    "EstimatedCompletionTime" : "",
    "Status" : "COMPLETE_WITH_ERRORS",
    "ReadFromFile" : "6",
    "LoadedSuccessfully" : "4",
    "SuccessReportContentId" : "UCMFA00004208",
    "ErrorsReported" : "2",
    "Warnings" : "0",
    "ErrorReportContentId" : "UCMFA00004212",
    "ExceptionReportContentId" : "UCMFA00004210",
    "CreatedBy" : "MHoope",
    "CreationDate" : "2017-11-02T14:31:33.231+00:00",
    "LastUpdateDate" : "2017-11-02T14:34:16.678+00:00",
    "LastUpdateLogin" : "5D00AEE99B3C6470E053768DF50A7C87",
    "LastUpdatedBy" : "MHoope",
    "links" : 
	...
	}
	],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": 
  ...
  }
Back to Top