Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

ファイル・インポート・アクティビティ・データ・ファイルの作成

post

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

リクエスト

パス・パラメータ

ImportActivityId(required): integer(int64)

インポート・アクティビティを表す一意の識別子。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

FileName: string

タイトル: File Name

最大長: 150

ソースCSVファイルの名前。
InputFileContentId: string

タイトル: Source File Content ID

最大長: 150

ソースCSVファイルの一意のUCMコンテンツ識別子。
MessageCode: string

最大長: 100

インポート・ジョブに関連するメッセージ・コードを示します。

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

トップに戻る

応答

サポートされるメディア・タイプ

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : importActivities-DataFiles-item-response

タイプ: object

ソースを表示

CanceledBy: string

読取り専用: true

インポート・ジョブを取り消したユーザーを示します。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
Description: string

タイトル: Description

読取り専用: true

インポート・ジョブの説明。
EndTime: string (date-time)

タイトル: End Time

読取り専用: true

ソース・データファイルの処理が終了する日時。
ErrorReportContentId: string

タイトル: Error File Content ID

読取り専用: true

エラー・レポート・ファイルの一意の識別子。
ErrorsReported: string

タイトル: Records with Errors

読取り専用: true

最大長: 150

ソースCSVファイルから読み取られたインポート・レコードの数。
EstimatedCompletionTime: string

タイトル: Estimated Completion Time

読取り専用: true

最大長: 150

ソースCSVファイルのインポートの処理にかかるおおよその時間。
ExceptionReportContentId: string

タイトル: Exception File Content ID

読取り専用: true

例外レポート・ファイルの一意の識別子。
FileName: string

タイトル: File Name

最大長: 150

ソースCSVファイルの名前。
InputFileContentId: string

タイトル: Source File Content ID

最大長: 150

ソースCSVファイルの一意のUCMコンテンツ識別子。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

レコードが最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Updated

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
LoadedSuccessfully: string

タイトル: Successfully Loaded

読取り専用: true

最大長: 150

ソースCSVファイルから正常にロードされたインポート・レコードの数。
MessageCode: string

最大長: 100

インポート・ジョブに関連するメッセージ・コードを示します。
ReadFromFile: string

タイトル: Total Records

読取り専用: true

最大長: 150

ソースCSVファイルから読み取られたインポート・レコードの数。
Size: string

タイトル: File Size

読取り専用: true

ソースCSVファイルのファイル・サイズ。
StartTime: string (date-time)

タイトル: Start Time

読取り専用: true

ソース・データ・ファイルの処理が開始される日時。
Status: string

タイトル: Status

読取り専用: true

ソースCSVファイル・インポート処理の現在のステータス。
SuccessReportContentId: string

タイトル: Success File Content ID

読取り専用: true

インポートが正常に完了したときに生成される成功レポート・ファイルの一意の識別子。
Title: string

タイトル: Title

読取り専用: true

ソースCSVファイルのファイル名タイトル。
Unprocessed: string

読取り専用: true

このフィールドには、取消されたジョブの未処理レコード数が表示されます
Warnings: string

タイトル: Records with Warnings

読取り専用: true

最大長: 150

ソースCSVファイルから処理されたインポート・レコードの数で、警告が発生しました。

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

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: 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."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

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

リンク

DataFilesStatusVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKT_IMPORT_SCHEDULE_STATUS

インポート・アクティビティ・データ・ファイルの有効なステータスのリスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: ステータス;ターゲット属性: LookupCode
表示属性: 意味

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行して、ファイル・インポート・アクティビティ・データ・ファイルを作成する方法を示しています。

cURLコマンド

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

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
 "InputFileContentId": "UCMFA00007278"
 }

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

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

「トップに戻る」