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

機械翻訳について

ファイル・インポート・マップの更新

patch

/crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}

リクエスト

パス・パラメータ

MappingNumber(required): string

インポート・マッピングの代替キー識別子。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

Description: string

タイトル: Description

最大長: 250

インポート・マッピングの簡単な説明。
ImportMappingColumns: array Import Activity Map Columns

タイトル: Import Activity Map Columns

インポート・マッピング列のリソースは、ソースCSVファイルの列ヘッダーとファイル・インポート・オブジェクト属性の間のマッピングを示すファイル・インポート・マップのエントリを表示、作成、更新および削除するために使用されます。
MappingNumber: string

タイトル: Mapping Number

最大長: 130

インポート・マッピングの代替キー識別子。
Name(required): string

タイトル: File Import Mapping

最大長: 100

インポート・マッピングの名前。
ObjectCode(required): string

タイトル: Object

最大長: 100

最適化されたインポート・オプションを使用してインポートされたオブジェクトのタイプを示すコード。たとえば、取引先、担当者、商談などです。

{
    "required":[
        "Name",
        "ObjectCode"
    ],
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":250,
            "type":"string",
            "description":"A brief description of the import mapping.",
            "nullable":true
        },
        "ObjectCode":{
            "title":"Object",
            "maxLength":100,
            "type":"string",
            "description":"The code indicating the type of object imported using the optimized Import option. For example, Accounts, Contacts, or Opportunities.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MappingNumber":{
            "title":"Mapping Number",
            "maxLength":130,
            "type":"string",
            "description":"The alternate key identifier of the import mapping.",
            "nullable":false
        },
        "ImportMappingColumns":{
            "title":"Import Activity Map Columns",
            "type":"array",
            "description":"The import mapping columns resource is used to view, create, update, and delete an entry in a file import map which shows the mapping between a source CSV file column header and a file import object attribute.",
            "items":{
                "$ref":"#/components/schemas/importMappings-ImportMappingColumns-item-patch-request"
            }
        },
        "Name":{
            "title":"File Import Mapping",
            "maxLength":100,
            "type":"string",
            "description":"The name of the import mapping.",
            "nullable":false
        }
    }
}

ネストされたスキーマ : アクティビティ・マップ列のインポート

タイプ: array

タイトル: Import Activity Map Columns

インポート・マッピング列のリソースは、ソースCSVファイルの列ヘッダーとファイル・インポート・オブジェクト属性の間のマッピングを示すファイル・インポート・マップのエントリを表示、作成、更新および削除するために使用されます。

ソースを表示

Array of: object schema

{
    "title":"Import Activity Map Columns",
    "type":"array",
    "description":"The import mapping columns resource is used to view, create, update, and delete an entry in a file import map which shows the mapping between a source CSV file column header and a file import object attribute.",
    "items":{
        "$ref":"#/components/schemas/importMappings-ImportMappingColumns-item-patch-request"
    }
}

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

タイプ: object

ソースを表示

AttributeCode: string

タイトル: Attribute Name

ソース・ファイルの列ヘッダーにマップされる属性のタイプを示すコード。有効な値のリストは、参照FUSION.ZCA_OBJECT_ATTRIBUTESで定義されます。
AttributeDisplayName: string

タイトル: Attribute Display Name

ソース・ファイルの列ヘッダーにマップされたインポート・オブジェクト属性表示名。
ColumnHeader: string

タイトル: Column Header

最大長: 500

CSVソース・ファイルの列ヘッダー名。
ExampleValue: string

タイトル: Example Value

最大長: 100

それぞれのソース・ファイル列の値の例。
Ignore: string

タイトル: Ignore

最大長: 1

インポート時にソース・ファイルの列ヘッダー値を無視するかどうかを示します。
MappingColumnNumber: string

タイトル: Mapping Column Number

最大長: 160

インポート・マッピング列の代替キー識別子。

{
    "type":"object",
    "properties":{
        "AttributeCode":{
            "title":"Attribute Name",
            "type":"string",
            "description":"The code indicating the type of the attribute mapped to the source file column header. A list of valid values is defined in the lookup FUSION.ZCA_OBJECT_ATTRIBUTES .",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ColumnHeader":{
            "title":"Column Header",
            "maxLength":500,
            "type":"string",
            "description":"The column header name in the CSV source file.",
            "nullable":false
        },
        "Ignore":{
            "title":"Ignore",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the source file column header values should be ignored during import or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExampleValue":{
            "title":"Example Value",
            "maxLength":100,
            "type":"string",
            "description":"An example value for the respective source file column.",
            "nullable":true
        },
        "AttributeDisplayName":{
            "title":"Attribute Display Name",
            "type":"string",
            "description":"The import object attribute display name mapped to the source file column header.",
            "nullable":true
        },
        "MappingColumnNumber":{
            "title":"Mapping Column Number",
            "maxLength":160,
            "type":"string",
            "description":"The alternate key identifier of the import mapping column.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : importMappings-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

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

タイトル: Description

最大長: 250

インポート・マッピングの簡単な説明。
ImportMappingColumns: array Import Activity Map Columns

タイトル: Import Activity Map Columns

インポート・マッピング列のリソースは、ソースCSVファイルの列ヘッダーとファイル・インポート・オブジェクト属性の間のマッピングを示すファイル・インポート・マップのエントリを表示、作成、更新および削除するために使用されます。
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

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

タイトル: Mapping Number

最大長: 130

インポート・マッピングの代替キー識別子。
Name: string

タイトル: File Import Mapping

最大長: 100

インポート・マッピングの名前。
ObjectCode: string

タイトル: Object

最大長: 100

最適化されたインポート・オプションを使用してインポートされたオブジェクトのタイプを示すコード。たとえば、取引先、担当者、商談などです。

{
    "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
        },
        "Description":{
            "title":"Description",
            "maxLength":250,
            "type":"string",
            "description":"A brief description of the import mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "ImportMappingColumns":{
            "title":"Import Activity Map Columns",
            "type":"array",
            "description":"The import mapping columns resource is used to view, create, update, and delete an entry in a file import map which shows the mapping between a source CSV file column header and a file import object attribute.",
            "items":{
                "$ref":"#/components/schemas/importMappings-ImportMappingColumns-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectCode":{
            "title":"Object",
            "maxLength":100,
            "type":"string",
            "description":"The code indicating the type of object imported using the optimized Import option. For example, Accounts, Contacts, or Opportunities.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MappingNumber":{
            "title":"Mapping Number",
            "maxLength":130,
            "type":"string",
            "description":"The alternate key identifier of the import mapping.",
            "nullable":false,
            "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
        },
        "Name":{
            "title":"File Import Mapping",
            "maxLength":100,
            "type":"string",
            "description":"The name of the import mapping.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : アクティビティ・マップ列のインポート

タイプ: array

タイトル: Import Activity Map Columns

ソースを表示

Array of: object importMappings-ImportMappingColumns-item-response

{
    "title":"Import Activity Map Columns",
    "type":"array",
    "description":"The import mapping columns resource is used to view, create, update, and delete an entry in a file import map which shows the mapping between a source CSV file column header and a file import object attribute.",
    "items":{
        "$ref":"#/components/schemas/importMappings-ImportMappingColumns-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"
    }
}

ネストされたスキーマ : importMappings-ImportMappingColumns-item-response

タイプ: object

ソースを表示

AttributeCode: string

タイトル: Attribute Name

ソース・ファイルの列ヘッダーにマップされる属性のタイプを示すコード。有効な値のリストは、参照FUSION.ZCA_OBJECT_ATTRIBUTESで定義されます。
AttributeDisplayName: string

タイトル: Attribute Display Name

ソース・ファイルの列ヘッダーにマップされたインポート・オブジェクト属性表示名。
ColumnHeader: string

タイトル: Column Header

最大長: 500

CSVソース・ファイルの列ヘッダー名。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

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

タイトル: Example Value

最大長: 100

それぞれのソース・ファイル列の値の例。
Ignore: string

タイトル: Ignore

最大長: 1

インポート時にソース・ファイルの列ヘッダー値を無視するかどうかを示します。
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

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

タイトル: Mapping Column Number

最大長: 160

インポート・マッピング列の代替キー識別子。

{
    "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
        },
        "AttributeCode":{
            "title":"Attribute Name",
            "type":"string",
            "description":"The code indicating the type of the attribute mapped to the source file column header. A list of valid values is defined in the lookup FUSION.ZCA_OBJECT_ATTRIBUTES .",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ColumnHeader":{
            "title":"Column Header",
            "maxLength":500,
            "type":"string",
            "description":"The column header name in the CSV source file.",
            "nullable":false,
            "x-queryable":true
        },
        "Ignore":{
            "title":"Ignore",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the source file column header values should be ignored during import or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "ExampleValue":{
            "title":"Example Value",
            "maxLength":100,
            "type":"string",
            "description":"An example value for the respective source file column.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDisplayName":{
            "title":"Attribute Display Name",
            "type":"string",
            "description":"The import object attribute display name mapped to the source file column header.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MappingColumnNumber":{
            "title":"Mapping Column Number",
            "maxLength":160,
            "type":"string",
            "description":"The alternate key identifier of the import mapping column.",
            "nullable":false,
            "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."
        }
    }
}

リンク

ImportMappingColumns

操作: /crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}/child/ImportMappingColumns

パラメータ:

MappingNumber: $request.path.MappingNumber

ImportObjectsVA

操作: /crmRestApi/resources/11.13.18.05/importExportObjectMetadata

パラメータ:

ファインダ: objectRowFinder

インポート・エクスポート・オブジェクト・メタデータ・リソースは、ファイルベースのインポートおよびエクスポートをサポートするオブジェクトの表示に使用されます。

トップに戻る

例:

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

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/300100123778224

リクエスト本文の例

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

{
 	"Name" : "Acc_Update",
  "Description" : null,
  "ObjectCode" : "Account"
}

レスポンス本文の例

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

{
 "ImportActivityId" : 300100123778224,
  "Name" : "Acc_Update",
  "Description" : null,
  "ObjectCode" : "Account",
  "AttachmentObjectCode" : null,
  "DecimalSeparator" : ".",
  "DateFormat" : "ORA_ZCA_US_FORMAT",
  "ImportMode" : "CREATE_RECORD",
  "TimestampFormat" : "ORA_ZCA_US_FORMAT",
  "FileEncoding" : "ORA_ZCA_UTF8_ENCODING",
  "Delimiter" : "COMMA_DELIMITER",
  "NotificationEmail" : null,
  "ImportMapping" : null,
  "Schedule" : "ONE_TIME_IMMEDIATE",
  "ScheduleTime" : null,
  "Activate" : "NO",
  "CreatedBy" : "SALES_ADMIN",
  "CreationDate" : "2017-11-02T15:09:59+00:00",
  "LastUpdateDate" : "2017-11-02T15:11:18+00:00",
  "LastUpdatedBy" : "SALES_ADMIN",
  "LastUpdateLogin" : "5D00CDF67DFA656CE053768DF50A4CED",
  "HighVolume" : "NO",
  "links": [
  ...
  ]
  }

「トップに戻る」