機械翻訳について

一括エクスポート・アクティビティの取得

get

/crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : bulkExportActivities-item-response
タイプ: object
ソースを表示
  • タイトル: Activate
    デフォルト値: NO
    エクスポート・ジョブをアクティブ化するかどうかを指定する属性。 アクティブ化すると、ジョブが実行キューに入れられます。
  • Export Attachments
    タイトル: Export Attachments
    添付リソースは、オブジェクトの添付のエクスポートに使用されます。
  • タイトル: Export Job Identifier
    エクスポート・ジョブの一意の識別子。
  • RESTを介したエクスポート・ジョブの取消に使用
  • 読取り専用: true
    エクスポート・ジョブを取り消したユーザーを示します
  • Export Child Object Activities
    タイトル: Export Child Object Activities
    子オブジェクト・アクティビティのエクスポート・リソースは、ターゲット表から大量の子オブジェクト・データを表示、作成および更新するために使用されます。 子の一括エクスポート・アクティビティ・リソースは、複数のレベルの階層ツリーのエクスポートにも使用できます。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日時。
  • 読取り専用: true
    現在ログインしているユーザーを指定
  • タイトル: Date Format
    最大長: 120
    デフォルト値: ORA_ZCA_US_FORMAT
    エクスポートされたファイルの日付値の形式。
  • タイトル: Delimiter
    最大長: 30
    デフォルト値: COMMA_DELIMITER
    エクスポートされたファイルに使用されるデリミタ。
  • タイトル: Description
    最大長: 250
    ユーザーが指定したエクスポート・ジョブの説明。
  • タイトル: Export attachments
    最大長: 20
    デフォルト値: NO
    添付のエクスポートを使用可能にします
  • タイトル: Enable Split
    最大長: 20
    デフォルト値: NO
    エクスポート・ファイルを複数のファイルに分割するかどうかを指定します。 指定したレコード数に基づいてエクスポート・データ・セットを分割するには、はいを選択します。 デフォルトはNOです。
  • タイトル: End Time
    読取り専用: true
    エクスポート・ジョブが終了する時間。
  • 読取り専用: true
    添付のエクスポート・エラー・ファイルの内容。
  • タイトル: Error File URL
    ブラウザでエラー・ファイルをダウンロードするために使用するURL。 エラー・ファイルのzipファイルの内容をプログラムでダウンロードするには、/enclosure/ErrorReportFileContentsリンクに従います。
  • タイトル: Escape Special Characters
    引用符、デリミタ、改行などの特殊文字を除外するかどうかを示します。 デフォルト値はfalseです。
  • タイトル: Export Column Names
    エクスポートされるオブジェクト列。
  • 読取り専用: true
    添付されたエクスポート・ファイルの内容。
  • タイトル: Export File Name
    最大長: 250
    ファイル・リポジトリにアップロードされるエクスポート済ファイルの名前。
  • タイトル: Export File URL
    ブラウザでのエクスポート・ファイルのダウンロードに使用されるURL。 エクスポートされたzipファイルの内容をプログラムでダウンロードするには、/enclosure/ExportFileContentsリンクに従います。
  • タイトル: Export Filter Criteria
    最大長: 4000
    エクスポートするレコードを指定するエクスポート・オブジェクト・フィルタ基準。
  • タイトル: Export Mapping
    エクスポートされるレコードのリストを指定する、以前に定義したオブジェクト・フィルタ基準およびマッピング。
  • タイトル: Object Code
    最大長: 128
    エクスポートされるオブジェクトの名前。
  • タイトル: Order By
    最大長: 1000
    エクスポートされたファイルの列の順序。
  • タイトル: File Encoding
    最大長: 30
    デフォルト値: ORA_ZCA_UTF8_ENCODING
    エクスポート・ファイル内の文字がエンコードされる形式。
  • タイトル: Enable Round Trip
    ジョブおよび自動マッピングのラウンドトリップを有効にするために使用される、エクスポートされたファイルの言語非依存ヘッダー。
  • タイトル: Last Update Date
    読取り専用: true
    レコードが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Name
    最大長: 100
    個々のエクスポート・ジョブごとに指定された名前。
  • タイトル: Note Object
    ノートをエクスポートする必要があるエクスポート・オブジェクト・コード。
  • タイトル: Notification Email
    最大長: 500
    エクスポート・ジョブ・ステータスEメールが送信されるEメールID。
  • プライベート・マップは永続的であり、所有者のみが表示または削除できます。
  • タイトル: Records Exported
    読取り専用: true
    エクスポートされたレコードの合計数。
  • エクスポート・ジョブの完了後に通知が送信されるRESTエンドポイント名を指定します。
  • タイトル: Split Size
    分割が有効な場合の分割サイズを指定します。 分割サイズは、100000レコードの倍数で指定できます。 デフォルト値は、100000です。
  • タイトル: Start Time
    読取り専用: true
    エクスポート・ジョブが開始する時間。
  • タイトル: Status
    最大長: 30
    デフォルト値: NEW
    エクスポート・ジョブのステータス。
  • タイトル: Time Stamp Format
    最大長: 120
    デフォルト値: ORA_ZCA_US_FORMAT
    エクスポートされたファイルのタイムスタンプ値の形式。
ネストされたスキーマ : 添付のエクスポート
タイプ: array
タイトル: Export Attachments
添付リソースは、オブジェクトの添付のエクスポートに使用されます。
ソースを表示
ネストされたスキーマ : 子オブジェクト・アクティビティのエクスポート
タイプ: array
タイトル: Export Child Object Activities
子オブジェクト・アクティビティのエクスポート・リソースは、ターゲット表から大量の子オブジェクト・データを表示、作成および更新するために使用されます。 子の一括エクスポート・アクティビティ・リソースは、複数のレベルの階層ツリーのエクスポートにも使用できます。
ソースを表示
ネストされたスキーマ : bulkExportActivities-Attachments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : bulkExportActivities-childBulkExportActivity-item-response
タイプ: object
ソースを表示
  • Export Child Object Activities
    タイトル: Export Child Object Activities
    子オブジェクト・アクティビティのエクスポート・リソースは、ターゲット表から大量の子オブジェクト・データを表示、作成および更新するために使用されます。 子の一括エクスポート・アクティビティ・リソースは、複数のレベルの階層ツリーのエクスポートにも使用できます。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日時。
  • タイトル: Export Column Names
    エクスポートされるオブジェクト列。
  • タイトル: Export Filter Criteria
    最大長: 4000
    エクスポートするレコードを指定するエクスポート・オブジェクト・フィルタ基準。
  • タイトル: Object Code
    最大長: 128
    エクスポートされるオブジェクトの名前。
  • タイトル: Order By
    最大長: 1000
    エクスポートされたファイルの列の順序。
  • タイトル: Export Parent Object
    最大長: 128
    エクスポートされる親オブジェクトの名前。
  • タイトル: Last Update Date
    読取り専用: true
    レコードが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Records Exported
    読取り専用: true
    エクスポートされたレコードの合計数。
ネストされたスキーマ : 子オブジェクト・アクティビティのエクスポート
タイプ: array
タイトル: Export Child Object Activities
子オブジェクト・アクティビティのエクスポート・リソースは、ターゲット表から大量の子オブジェクト・データを表示、作成および更新するために使用されます。 子の一括エクスポート・アクティビティ・リソースは、複数のレベルの階層ツリーのエクスポートにも使用できます。
ソースを表示
ネストされたスキーマ : bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日時。
  • タイトル: Export Column Names
    エクスポートされるオブジェクト列。
  • タイトル: Export Filter Criteria
    最大長: 4000
    エクスポートするレコードを指定するエクスポート・オブジェクト・フィルタ基準。
  • タイトル: Object Code
    最大長: 128
    エクスポートされるオブジェクトの名前。
  • タイトル: Order By
    最大長: 1000
    エクスポートされたファイルの列の順序。
  • タイトル: Export Parent Object
    最大長: 128
    エクスポートされる親オブジェクトの名前。
  • タイトル: Last Update Date
    読取り専用: true
    レコードが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Records Exported
    読取り専用: true
    エクスポートされたレコードの合計数。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、一括エクスポート・アクティビティを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}

レスポンス本文の例

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

{
    "BulkExportJobId": 300100183509438,
    "Name": "Acct_Export",
    "Description": null,
    "ExportObject": "Account",
    "ExportMapping": "null",
    "ExportColumnNames": "EmailContactPointType,EmailAddress,WebContactPointType,URL,PartyNumberKey,AddressNumber,Country,PartyId,PartyNumber,OrganizationProfileId,OrganizationName,PartyUniqueName,SalesProfileNumber,OwnerPartyNumber,OwnerName,PartyType,CreatedBy,CreationDate,LastUpdateDate,LastUpdatedBy,PhoneContactPointType,FaxContactPointType",
    "ExportFilterCriteria": "OrganizationName IS NOT NULL",
    "ExportOrderBy": null,
    "ExportFileName": "Account20190927_1103.zip",
    "Status": "COMPLETE",
    "Activate": "YES",
    "DateFormat": "ORA_ZCA_US_FORMAT",
    "TimestampFormat": "ORA_ZCA_US_FORMAT",
    "Delimiter": "COMMA_DELIMITER",
    "EscapeSpecialCharactersFlag": "false",
    "RecordsExported": "",
    "ExportFileURL": "FUSION doesn't have access to this file. (ZCA-210338)",
    "ErrorReportFileURL": "FUSION doesn't have access to this file. (ZCA-210338)",
    "NotificationEMail": null,
    "FileCharset": "ORA_ZCA_UTF8_ENCODING",
    "CreatedBy": "MHoope",
    "CreationDate": "2019-09-27T11:03:08+00:00",
    "LastUpdateDate": "2019-09-27T11:09:48+00:00",
    "LastUpdatedBy": "MHoope",
    "LastUpdateLogin": "9386952CF31776BCE053A15AF00A09EE",
    "StartTm": null,
    "EndTm": null,
    "LangIndependentHeader": "NO",
    "NoteObjectCode": null,
    "EnableSplit": "NO",
    "SplitSize": 100000,
    "EnableExportAttachment": null,
    "CurrentLoggedInUser": "FUSION",
    "RestNotification": null,
    "Cancel": null,
    "CanceledBy": null,
    "PrivateMap": "N",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438",
            "name": "bulkExportActivities",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000003770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000C7371007E0002000000017371007E00020000000378"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438",
            "name": "bulkExportActivities",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438/child/Attachments",
            "name": "Attachments",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438/child/childBulkExportActivity",
            "name": "childBulkExportActivity",
            "kind": "collection"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438/enclosure/ExportFileContents",
            "name": "ExportFileContents",
            "kind": "other"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438/enclosure/ErrorReportFileContents",
            "name": "ErrorReportFileContents",
            "kind": "other"
        }
    ]
}
「トップに戻る」