Jump to

• Request
• Response
• Examples

Create a file import activity data file

post

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

Request

Path Parameters

• ImportActivityId(required): integer(int64)
  The unique identifier that represents an import activity.

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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":{
        "FileName":{
            "title":"File Name",
            "maxLength":150,
            "type":"string",
            "description":"The name for the source CSV file.",
            "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
        },
        "MessageCode":{
            "maxLength":100,
            "type":"string",
            "description":"Indicates the Message Code related to import job.",
            "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-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."
        }
    }
}

Links

DataFilesStatusVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKT_IMPORT_SCHEDULE_STATUS

The list of valid statuses for an import activity data file.

The following properties are defined on the LOV link relation:

• Source Attribute: Status; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top

Examples

The following example shows how to create a file import activity data file by submitting a POST request on the REST resource using cURL.

cURL Command

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

Example of Request Body

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

{
 "InputFileContentId": "UCMFA00007278"
 }

Example of Response Body

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

{
 "FileName" : null,
  "Title" : null,
  "Size" : null,
  "Description" : "User provided input data file",
  "InputFileContentId" : "UCMFA00007278",
  "StartTime" : null,
  "EndTime" : null,
  "EstimatedCompletionTime" : null,
  "Status" : "ORA_MKT_QUEUED",
  "ReadFromFile" : null,
  "LoadedSuccessfully" : null,
  "SuccessReportContentId" : null,
  "ErrorsReported" : null,
  "Warnings" : null,
  "ErrorReportContentId" : null,
  "ExceptionReportContentId" : null,
  "CreatedBy" : "SALES_ADMIN",
  "CreationDate" : "2017-11-03T05:15:16+00:00",
  "LastUpdateDate" : "2017-11-03T05:15:16.076+00:00",
  "LastUpdateLogin" : "5D0B0B6EB0A51FF9E05309C5F20A3696",
  "LastUpdatedBy" : "SALES_ADMIN",
   "links" : 
	...
  }

Back to Top