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

機械翻訳について

営業リード製品の更新

patch

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklProdAssoc1/{LeadProductId}

リクエスト

パス・パラメータ

LeadProductId(required): integer(int64)

現在の営業リード製品の一意の識別子。
leadsUniqID(required): string

これは、営業リード・リソースの複合キーを構成し、営業リードのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、営業リードの特定のインスタンスに移動してハッシュ・キーを取得するために、営業リード・コレクション・リソースを問い合せる必要があります。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

金額: number

タイトル: Amount

営業リード製品に関連付けられた金額。
AverageTimeToClose: number

タイトル: Average Time to Close

この営業リード製品の平均クローズ時間。
ConflictId: integer

タイトル: Conflict Identifier

デフォルト値: 0

この値によって、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。
CurrencyCode: string

タイトル: Currency

最大長: 15

リード製品明細金額に関連付けられた通貨コード。受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。この属性の値は、「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用してレビューおよび更新できます。
Description: string

タイトル: Item Description

最大長: 240

製品が見込み客に関連付けられている製品説明。
EstimatedUnitPrice: number

タイトル: Estimated Unit Price

このリード製品の見積単価。
InventoryItemId: integer (int64)

タイトル: Inventory Number

リード製品に関連付けられた一意の在庫品目識別子。
LeadProductId: integer (int64)

タイトル: Lead Product ID

現在の営業リード製品の一意の識別子。
OrganizationId: integer (int64)

タイトル: Organization

このリード製品に関連付けられた一意の在庫組織識別子。
PrimaryFlag: boolean

タイトル: Primary

最大長: 1

この製品がこのリードのプライマリ製品であるかどうかを示します。
ProductGroupId: integer (int64)

タイトル: Product Group ID

製品グループの一意の識別子。
ProductGroupName: string

タイトル: Product Group Name

最大長: 250

営業リード製品リソースに関連付けられている製品グループの名前。
ProductGroupReferenceNumber: string

タイトル: Product Group Reference Number

最大長: 50

参照製品グループの代替キー。
ProductType: string

タイトル: Product Type

製品のタイプ(品目または製品グループなど)。
数量: number

タイトル: Quantity

リードのこの製品に対して識別される製品数量。
UOMCode: string

タイトル: UOM

最大長: 3

この営業リード製品明細に関連付けられた単位。

{
    "type":"object",
    "properties":{
        "ProductGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"CRMProductGroup",
                "RecentItemEntityName":"CRMProductGroup"
            }
        },
        "ProductGroupReferenceNumber":{
            "title":"Product Group Reference Number",
            "maxLength":50,
            "type":"string",
            "description":"The alternate key for referenced product group.",
            "nullable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this product is a primary product for this lead.",
            "nullable":true
        },
        "Description":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"The product description where the product is associated with the lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EstimatedUnitPrice":{
            "title":"Estimated Unit Price",
            "type":"number",
            "description":"The estimated unit price for this lead product.",
            "nullable":true
        },
        "InventoryItemId":{
            "title":"Inventory Number",
            "type":"integer",
            "description":"The unique inventory item identifier associated with the lead product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"CRMProduct",
                "RecentItemEntityName":"CRMProduct"
            }
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount associated with the sales lead product.",
            "nullable":true
        },
        "ProductType":{
            "title":"Product Type",
            "type":"string",
            "description":"The type of the product, such as item or product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The product quantity identified for this product on the lead.",
            "nullable":true
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"The unique inventory organization identifier associated with this lead product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProductGroupName":{
            "title":"Product Group Name",
            "maxLength":250,
            "type":"string",
            "description":"The name of the product group associated with the sales lead product resource.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ConflictId":{
            "title":"Conflict Identifier",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "nullable":false,
            "default":0
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the lead product line amount. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. You can review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "LeadProductId":{
            "title":"Lead Product ID",
            "type":"integer",
            "description":"The unique identifier of the current sales lead product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure associated with this sales lead product line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InventoryItemId"
                ]
            }
        },
        "AverageTimeToClose":{
            "title":"Average Time to Close",
            "type":"number",
            "description":"The average time to close for this sales lead product.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : leads-MklProdAssoc1-item-response

タイプ: object

ソースを表示

金額: number

タイトル: Amount

営業リード製品に関連付けられた金額。
AverageTimeToClose: number

タイトル: Average Time to Close

この営業リード製品の平均クローズ時間。
ConflictId: integer

タイトル: Conflict Identifier

デフォルト値: 0

この値によって、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

この営業リード製品を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

この営業リード製品が作成された日時。
CurrencyCode: string

タイトル: Currency

最大長: 15

リード製品明細金額に関連付けられた通貨コード。受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。この属性の値は、「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用してレビューおよび更新できます。
Description: string

タイトル: Item Description

最大長: 240

製品が見込み客に関連付けられている製品説明。
EstimatedUnitPrice: number

タイトル: Estimated Unit Price

このリード製品の見積単価。
InventoryItemId: integer (int64)

タイトル: Inventory Number

リード製品に関連付けられた一意の在庫品目識別子。
ItemNumber: string

タイトル: Inventory Item Number

読取り専用: true

最大長: 300

参照在庫品目の代替キー。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

営業リード製品の最終更新日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

営業リード製品を最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Updated Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
LeadId: integer (int64)

タイトル: Lead ID

この営業リード製品の営業リードの一意の識別子。
LeadNumber: string

タイトル: Lead Number

最大長: 30

リードの代替一意識別子。
LeadProductId: integer (int64)

タイトル: Lead Product ID

現在の営業リード製品の一意の識別子。
LeadProductNumber: string

タイトル: Lead Product Number

最大長: 30

見込み客製品の代替キー。
links: array Links

タイトル: Links

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

タイトル: Long Description

読取り専用: true

最大長: 4000

営業リード製品の詳細な説明。
OrganizationId: integer (int64)

タイトル: Organization

このリード製品に関連付けられた一意の在庫組織識別子。
PrimaryFlag: boolean

タイトル: Primary

最大長: 1

この製品がこのリードのプライマリ製品であるかどうかを示します。
ProductGroupDescription: string

タイトル: Product Group Description

読取り専用: true

最大長: 1000

製品グループの簡単な説明。
ProductGroupId: integer (int64)

タイトル: Product Group ID

製品グループの一意の識別子。
ProductGroupName: string

タイトル: Product Group Name

最大長: 250

営業リード製品リソースに関連付けられている製品グループの名前。
ProductGroupReferenceNumber: string

タイトル: Product Group Reference Number

最大長: 50

参照製品グループの代替キー。
ProductType: string

タイトル: Product Type

製品のタイプ(品目または製品グループなど)。
数量: number

タイトル: Quantity

リードのこの製品に対して識別される製品数量。
UOMCode: string

タイトル: UOM

最大長: 3

この営業リード製品明細に関連付けられた単位。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when this sales lead product is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this product is a primary product for this lead.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"The product description where the product is associated with the lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EstimatedUnitPrice":{
            "title":"Estimated Unit Price",
            "type":"number",
            "description":"The estimated unit price for this lead product.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupDescription":{
            "title":"Product Group Description",
            "maxLength":1000,
            "type":"string",
            "description":"A brief description of the product group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"The unique inventory organization identifier associated with this lead product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Product Group Name",
            "maxLength":250,
            "type":"string",
            "description":"The name of the product group associated with the sales lead product resource.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict Identifier",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "nullable":false,
            "default":0,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the lead product line amount. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. You can review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Inventory Item Number",
            "maxLength":300,
            "type":"string",
            "description":"The alternate key for referenced inventory item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "OrganizationId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the sales lead for this sales lead product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LeadProductId":{
            "title":"Lead Product ID",
            "type":"integer",
            "description":"The unique identifier of the current sales lead product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure associated with this sales lead product line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InventoryItemId"
                ]
            },
            "x-queryable":true
        },
        "AverageTimeToClose":{
            "title":"Average Time to Close",
            "type":"number",
            "description":"The average time to close for this sales lead product.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the sales lead product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"CRMProductGroup",
                "RecentItemEntityName":"CRMProductGroup"
            },
            "x-queryable":true
        },
        "ProductGroupReferenceNumber":{
            "title":"Product Group Reference Number",
            "maxLength":50,
            "type":"string",
            "description":"The alternate key for referenced product group.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created this sales lead product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Inventory Number",
            "type":"integer",
            "description":"The unique inventory item identifier associated with the lead product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"CRMProduct",
                "RecentItemEntityName":"CRMProduct"
            },
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount associated with the sales lead product.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductType":{
            "title":"Product Type",
            "type":"string",
            "description":"The type of the product, such as item or product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the lead.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The product quantity identified for this product on the lead.",
            "nullable":true,
            "x-queryable":true
        },
        "LeadProductNumber":{
            "title":"Lead Product Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key of the lead product.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Long Description",
            "maxLength":4000,
            "type":"string",
            "description":"A detailed description of the sales lead product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time of the last update of the sales lead product.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "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."
        }
    }
}

リンク

ProductGroupExtnLovVA

操作: /crmRestApi/resources/11.13.18.05/productGroups

パラメータ:

ファインダ: ProductGroupList%3BBind_UsageCode%3DBASE%2CBind_UsageModeCode%3DMKL

製品グループ詳細ベース・パブリック・ビュー・オブジェクトの名前。

ProductTypeLookupVOVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

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

参照リソースは、標準参照コードの表示に使用されます。

RatedCurrenciesVA

操作: /crmRestApi/resources/11.13.18.05/ratedCurrencies

レート通貨リソースは、CRMの通貨コードの詳細を表示するために使用されます。ルックアップZCA_COMMON_CORPORATE_CURRENCYに定義されている、受け入れられる値のリストが表示されます。

SalesCatalogExtnProductsLovVA

操作: /crmRestApi/resources/11.13.18.05/products

パラメータ:

ファインダ: ProductList%3BBind_UsageCode%3DBASE%2CBind_UsageModeCode%3DMKL

製品リソースは、製品の表示、作成または変更に使用されます。製品とは、組織または会社が販売する予定の品目です。

トップに戻る

例:

cURLコマンド

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、営業リード製品を更新する方法を示しています。

curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklProdAssoc1/300100092582203

リクエスト本文の例

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

{
"PrimaryFlag" : true
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
  "LeadProductId" : 300100092582211,
  "LeadId" : 300100092582093,
  "OrganizationId" : 204,
  "CurrencyCode" : "USD",
  "EstimatedUnitPrice" : null,
  "InventoryItemId" : 999997500683977,
  "PrimaryFlag" : true,
  "ProductGroupId" : null,
  "Quantity" : null,
  "UOMCode" : null,
  "Description" : " OPN - World Applications - Certified Partner",
  "CreatedBy" : "MHoope",
  "CreationDate" : "2016-11-07T04:53:47-08:00",
  "LastUpdatedBy" : "MHoope",
  "LastUpdateDate" : "2016-11-07T04:57:38-08:00",
  "AverageTimeToClose" : null,
  "ProductGroupName" : null,
  "ProductGroupDescription" : null,
  "LongDescription" : "License/Applications/ERP Applications/PeopleSoft ERP Applications/JD Edwards World ERP/OPN - World License/ OPN - World Applications - Certified Partner",
  "Amount" : null,
  "links" : [ {
.............
}]
}

「トップに戻る」