機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

子の一括エクスポート・アクティビティの作成

post

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

リクエスト

パス・パラメータ

• BulkExportJobId(required): integer(int64)
  エクスポート・ジョブの一意の識別子。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

• application/json

リクエスト本文 - application/json ()

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

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

タイプ: object

ソースを表示

• childBulkExportActivity: array Export Child Object Activities
  タイトル: Export Child Object Activities

  子オブジェクト・アクティビティのエクスポート・リソースは、ターゲット表から大量の子オブジェクト・データを表示、作成および更新するために使用されます。 子の一括エクスポート・アクティビティ・リソースは、複数のレベルの階層ツリーのエクスポートにも使用できます。
• ExportColumnNames: string
  タイトル: Export Column Names

  エクスポートされるオブジェクト列。
• ExportFilterCriteria: string
  タイトル: Export Filter Criteria

  最大長: 4000

  エクスポートするレコードを指定するエクスポート・オブジェクト・フィルタ基準。
• ExportObject(required): string
  タイトル: Object Code

  最大長: 128

  エクスポートされるオブジェクトの名前。
• ExportOrderBy: string
  タイトル: Order By

  最大長: 1000

  エクスポートされたファイルの列の順序。
• ExportParentObject: string
  タイトル: Export Parent Object

  最大長: 128

  エクスポートされる親オブジェクトの名前。

{
    "required":[
        "ExportObject"
    ],
    "type":"object",
    "properties":{
        "ExportObject":{
            "title":"Object Code",
            "maxLength":128,
            "type":"string",
            "description":"The name of the object that is exported.",
            "nullable":false
        },
        "ExportOrderBy":{
            "title":"Order By",
            "maxLength":1000,
            "type":"string",
            "description":"The order of the columns in the exported file.",
            "nullable":true
        },
        "childBulkExportActivity":{
            "title":"Export Child Object Activities",
            "type":"array",
            "description":"The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.",
            "items":{
                "$ref":"#/components/schemas/bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-post-request"
            }
        },
        "ExportColumnNames":{
            "title":"Export Column Names",
            "type":"string",
            "description":"The object columns that are exported.",
            "nullable":true
        },
        "ExportParentObject":{
            "title":"Export Parent Object",
            "maxLength":128,
            "type":"string",
            "description":"The name of the parent object that is exported.",
            "nullable":true
        },
        "ExportFilterCriteria":{
            "title":"Export Filter Criteria",
            "maxLength":4000,
            "type":"string",
            "description":"The export object filter criteria specifying which records will be exported.",
            "nullable":true
        }
    }
}

ネストされたスキーマ : 子オブジェクト・アクティビティのエクスポート

タイプ: array

タイトル: Export Child Object Activities

子オブジェクト・アクティビティのエクスポート・リソースは、ターゲット表から大量の子オブジェクト・データを表示、作成および更新するために使用されます。 子の一括エクスポート・アクティビティ・リソースは、複数のレベルの階層ツリーのエクスポートにも使用できます。

ソースを表示

• Array of: object schema

{
    "title":"Export Child Object Activities",
    "type":"array",
    "description":"The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.",
    "items":{
        "$ref":"#/components/schemas/bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-post-request"
    }
}

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

タイプ: object

ソースを表示

• ExportColumnNames: string
  タイトル: Export Column Names

  エクスポートされるオブジェクト列。
• ExportFilterCriteria: string
  タイトル: Export Filter Criteria

  最大長: 4000

  エクスポートするレコードを指定するエクスポート・オブジェクト・フィルタ基準。
• ExportObject: string
  タイトル: Object Code

  最大長: 128

  エクスポートされるオブジェクトの名前。
• ExportOrderBy: string
  タイトル: Order By

  最大長: 1000

  エクスポートされたファイルの列の順序。
• ExportParentObject: string
  タイトル: Export Parent Object

  最大長: 128

  エクスポートされる親オブジェクトの名前。

{
    "type":"object",
    "properties":{
        "ExportObject":{
            "title":"Object Code",
            "maxLength":128,
            "type":"string",
            "description":"The name of the object that is exported.",
            "nullable":false
        },
        "ExportOrderBy":{
            "title":"Order By",
            "maxLength":1000,
            "type":"string",
            "description":"The order of the columns in the exported file.",
            "nullable":true
        },
        "ExportColumnNames":{
            "title":"Export Column Names",
            "type":"string",
            "description":"The object columns that are exported.",
            "nullable":true
        },
        "ExportParentObject":{
            "title":"Export Parent Object",
            "maxLength":128,
            "type":"string",
            "description":"The name of the parent object that is exported.",
            "nullable":true
        },
        "ExportFilterCriteria":{
            "title":"Export Filter Criteria",
            "maxLength":4000,
            "type":"string",
            "description":"The export object filter criteria specifying which records will be exported.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : bulkExportActivities-childBulkExportActivity-item-response

タイプ: object

ソースを表示

• childBulkExportActivity: array Export Child Object Activities
  タイトル: Export Child Object Activities

  子オブジェクト・アクティビティのエクスポート・リソースは、ターゲット表から大量の子オブジェクト・データを表示、作成および更新するために使用されます。 子の一括エクスポート・アクティビティ・リソースは、複数のレベルの階層ツリーのエクスポートにも使用できます。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日時。
• ExportColumnNames: string
  タイトル: Export Column Names

  エクスポートされるオブジェクト列。
• ExportFilterCriteria: string
  タイトル: Export Filter Criteria

  最大長: 4000

  エクスポートするレコードを指定するエクスポート・オブジェクト・フィルタ基準。
• ExportObject: string
  タイトル: Object Code

  最大長: 128

  エクスポートされるオブジェクトの名前。
• ExportOrderBy: string
  タイトル: Order By

  最大長: 1000

  エクスポートされたファイルの列の順序。
• ExportParentObject: string
  タイトル: Export Parent Object

  最大長: 128

  エクスポートされる親オブジェクトの名前。
• LastUpdateDate: string (date-time)
  タイトル: Last Update Date

  読取り専用: true

  レコードが最後に更新された日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

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

  リソース・インスタンスに関連付けられたリンク関係。
• RecordsExported: string
  タイトル: Records Exported

  読取り専用: true

  エクスポートされたレコードの合計数。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated 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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExportColumnNames":{
            "title":"Export Column Names",
            "type":"string",
            "description":"The object columns that are exported.",
            "nullable":true,
            "x-queryable":true
        },
        "ExportObject":{
            "title":"Object Code",
            "maxLength":128,
            "type":"string",
            "description":"The name of the object that is exported.",
            "nullable":false,
            "x-queryable":true
        },
        "ExportOrderBy":{
            "title":"Order By",
            "maxLength":1000,
            "type":"string",
            "description":"The order of the columns in the exported file.",
            "nullable":true,
            "x-queryable":true
        },
        "childBulkExportActivity":{
            "title":"Export Child Object Activities",
            "type":"array",
            "description":"The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.",
            "items":{
                "$ref":"#/components/schemas/bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-response"
            }
        },
        "RecordsExported":{
            "title":"Records Exported",
            "type":"string",
            "description":"The total number of records exported.",
            "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"
            }
        },
        "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":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExportParentObject":{
            "title":"Export Parent Object",
            "maxLength":128,
            "type":"string",
            "description":"The name of the parent object that is exported.",
            "nullable":true,
            "x-queryable":true
        },
        "ExportFilterCriteria":{
            "title":"Export Filter Criteria",
            "maxLength":4000,
            "type":"string",
            "description":"The export object filter criteria specifying which records will be exported.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 子オブジェクト・アクティビティのエクスポート

タイプ: array

タイトル: Export Child Object Activities

子オブジェクト・アクティビティのエクスポート・リソースは、ターゲット表から大量の子オブジェクト・データを表示、作成および更新するために使用されます。 子の一括エクスポート・アクティビティ・リソースは、複数のレベルの階層ツリーのエクスポートにも使用できます。

ソースを表示

• Array of: object bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-response

{
    "title":"Export Child Object Activities",
    "type":"array",
    "description":"The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.",
    "items":{
        "$ref":"#/components/schemas/bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-response"
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

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

ネストされたスキーマ : bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日時。
• ExportColumnNames: string
  タイトル: Export Column Names

  エクスポートされるオブジェクト列。
• ExportFilterCriteria: string
  タイトル: Export Filter Criteria

  最大長: 4000

  エクスポートするレコードを指定するエクスポート・オブジェクト・フィルタ基準。
• ExportObject: string
  タイトル: Object Code

  最大長: 128

  エクスポートされるオブジェクトの名前。
• ExportOrderBy: string
  タイトル: Order By

  最大長: 1000

  エクスポートされたファイルの列の順序。
• ExportParentObject: string
  タイトル: Export Parent Object

  最大長: 128

  エクスポートされる親オブジェクトの名前。
• LastUpdateDate: string (date-time)
  タイトル: Last Update Date

  読取り専用: true

  レコードが最後に更新された日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

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

  リソース・インスタンスに関連付けられたリンク関係。
• RecordsExported: string
  タイトル: Records Exported

  読取り専用: true

  エクスポートされたレコードの合計数。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated 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
        },
        "ExportObject":{
            "title":"Object Code",
            "maxLength":128,
            "type":"string",
            "description":"The name of the object that is exported.",
            "nullable":false,
            "x-queryable":true
        },
        "ExportOrderBy":{
            "title":"Order By",
            "maxLength":1000,
            "type":"string",
            "description":"The order of the columns in the exported file.",
            "nullable":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
        },
        "ExportColumnNames":{
            "title":"Export Column Names",
            "type":"string",
            "description":"The object columns that are exported.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordsExported":{
            "title":"Records Exported",
            "type":"string",
            "description":"The total number of records exported.",
            "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"
            }
        },
        "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":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExportParentObject":{
            "title":"Export Parent Object",
            "maxLength":128,
            "type":"string",
            "description":"The name of the parent object that is exported.",
            "nullable":true,
            "x-queryable":true
        },
        "ExportFilterCriteria":{
            "title":"Export Filter Criteria",
            "maxLength":4000,
            "type":"string",
            "description":"The export object filter criteria specifying which records will be exported.",
            "nullable":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."
        }
    }
}

リンク

childBulkExportActivity

操作: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/childBulkExportActivity/{ExportObject}/child/childBulkExportActivity

パラメータ:

• BulkExportJobId: $request.path.BulkExportJobId
• ExportObject: $request.path.ExportObject

ターゲット表からの子オブジェクト・データのエクスポートを可能にするプロセス。

トップに戻る

例:

次の例は、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/bulkExportActivities/300100125069284/child/childBulkExportActivity

リクエスト本文の例

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

{
"ExportObject": "Address",
"ExportParentObject": "Account",
"ExportColumnNames" : "City,Country,State,Status"
}

レスポンス本文の例

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

{
  "ExportObject" : "Address",
  "ExportParentObject" : "Account",
  "ExportColumnNames" : "City,Country,State,Status",
  "ExportFilterCriteria" : null,
  "ExportOrderBy" : null,
  "RecordsExported" : null,
  "CreatedBy" : "SALES_ADMIN",
  "CreationDate" : "2018-03-30T13:48:39+00:00",
  "LastUpdateDate" : "2018-03-30T13:48:39.030+00:00",
  "LastUpdateLogin" : "68A0FCD07B4DF329E053C30AF20AC1AB",
  "LastUpdatedBy" : "SALES_ADMIN",
  "links" : 
  ...
}

「トップに戻る」