機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. アクティビティのインポート
  4. アクティビティ・データ・ファイルのインポート

すべてのファイル・インポート・アクティビティ・データ・ファイルの取得

get

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

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • FileImportDataFileFinder : 指定されたコンテンツIDのファイル・インポート・アクティビティ・データ・ファイルを検索します。
      ファインダ変数:
      • InputFileContentId; string; データ・ファイルのコンテンツIDを識別する一意の値。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CanceledBy; string; インポート・ジョブを取り消したユーザーを示します。
    • CreatedBy; string; レコードを作成したユーザー。
    • CreationDate; string; レコードが作成された日時。
    • 説明、文字列。インポート・ジョブの説明。
    • EndTime; string; ソース・データファイルの処理が終了する日時。
    • ErrorReportContentId; string;エラー・レポート・ファイルの一意の識別子。
    • ErrorsReported; string;ソースCSVファイルから読み取られたインポート・レコードの数。
    • EstimatedCompletionTime; string;ソースCSVファイルのインポートの処理にかかるおおよその時間。
    • ExceptionReportContentId; string;例外レポート・ファイルの一意の識別子。
    • FileName; string;ソースCSVファイルの名前。
    • InputFileContentId; string;ソースCSVファイルのUCMコンテンツの一意の識別子。
    • LastUpdateDate; string; レコードが最後に更新された日時。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • LoadedSuccessfully; string;ソースCSVファイルから正常にロードされたインポート・レコードの数。
    • MessageCode; string; インポート・ジョブに関連するメッセージ・コードを示します。
    • ReadFromFile; string;ソースCSVファイルから読み取られたインポート・レコードの数。
    • Size; string;ソースCSVファイルのファイル・サイズ。
    • StartTime; string; ソース・データファイルの処理が開始される日時。
    • ステータス、文字列。ソースCSVファイルのインポート処理の現在のステータス。
    • SuccessReportContentId; string; インポートが正常に完了したときに生成される成功レポート・ファイルの一意の識別子。
    • Title; string;ソースCSVファイルのファイル名タイトル。
    • 未処理、文字列。このフィールドは、取り消されたジョブの未処理レコード数を表示
    • 警告、文字列。ソースCSVファイルから処理されたインポート・レコードの数で、警告が発生しました。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : importActivities-DataFiles
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : importActivities-DataFiles-item-response
タイプ: object
ソースを表示
  • 読取り専用: true
    インポート・ジョブを取り消したユーザーを示します。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日時。
  • タイトル: Description
    読取り専用: true
    インポート・ジョブの説明。
  • タイトル: End Time
    読取り専用: true
    ソース・データファイルの処理が終了する日時。
  • タイトル: Error File Content ID
    読取り専用: true
    エラー・レポート・ファイルの一意の識別子。
  • タイトル: Records with Errors
    読取り専用: true
    最大長: 150
    ソースCSVファイルから読み取られたインポート・レコードの数。
  • タイトル: Estimated Completion Time
    読取り専用: true
    最大長: 150
    ソースCSVファイルのインポートの処理にかかるおおよその時間。
  • タイトル: Exception File Content ID
    読取り専用: true
    例外レポート・ファイルの一意の識別子。
  • タイトル: File Name
    最大長: 150
    ソースCSVファイルの名前。
  • タイトル: Source File Content ID
    最大長: 150
    ソースCSVファイルの一意のUCMコンテンツ識別子。
  • タイトル: Last Update Date
    読取り専用: true
    レコードが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Updated
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Successfully Loaded
    読取り専用: true
    最大長: 150
    ソースCSVファイルから正常にロードされたインポート・レコードの数。
  • 最大長: 100
    インポート・ジョブに関連するメッセージ・コードを示します。
  • タイトル: Total Records
    読取り専用: true
    最大長: 150
    ソースCSVファイルから読み取られたインポート・レコードの数。
  • タイトル: File Size
    読取り専用: true
    ソースCSVファイルのファイル・サイズ。
  • タイトル: Start Time
    読取り専用: true
    ソース・データ・ファイルの処理が開始される日時。
  • タイトル: Status
    読取り専用: true
    ソースCSVファイル・インポート処理の現在のステータス。
  • タイトル: Success File Content ID
    読取り専用: true
    インポートが正常に完了したときに生成される成功レポート・ファイルの一意の識別子。
  • タイトル: Title
    読取り専用: true
    ソースCSVファイルのファイル名タイトル。
  • 読取り専用: true
    このフィールドには、取消されたジョブの未処理レコード数が表示されます
  • タイトル: Records with Warnings
    読取り専用: true
    最大長: 150
    ソースCSVファイルから処理されたインポート・レコードの数で、警告が発生しました。
トップに戻る

例:

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

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/300100123779027/child/DataFiles

レスポンス本文の例

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

{
  "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": 
  ...
  }
「トップに戻る」