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

機械翻訳について

ディール製品の取得

get

/crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealProduct/{DealProdId}

リクエスト

パス・パラメータ

DealProdId(required): integer(int64)

ディール登録製品の一意の識別子。
dealsUniqID(required): string

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

問合せパラメータ

dependency: string

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

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

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

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : deals-DealProduct-item-response

タイプ: object

ソースを表示

金額: number

タイトル: Amount

製品ラインに関連付けられている金額。金額は、数量×登録価格です。
ConvCurrencyCode: string

最大長: 15

取引交渉登録の通貨を変換する必要がある通貨コード。たとえば、企業通貨コードです。
ConvExchangeRate: number

入力通貨を標準CRM企業通貨に換算するための換算レート。
ConvRateType: string

最大長: 30

ユーザー入力通貨と、ディール登録に関連付けられたCRM企業通貨コードとの間の換算レートを導出するために使用される通貨換算レート・タイプ。
CreatedBy: string

読取り専用: true

最大長: 64

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

読取り専用: true

ディール製品レコードが作成された日時。
CurrencyCode: string

最大長: 15

通貨コード。この属性は、CRM拡張フレームワークで使用されます。有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
DealId: integer (int64)

親取引交渉登録の一意の識別子。
DealNumber: string

タイトル: Registration Number

最大長: 30

ディール登録の代替一意識別子。
DealProdId: integer (int64)

ディール登録製品の一意の識別子。
DealProdNumber: string

最大長: 30

ディール登録製品の代替一意識別子。
InventoryItemId: integer (int64)

取引交渉登録に関連付けられている製品在庫アイテムの一意の識別子。
InvOrgId: integer (int64)

在庫組織の一意の識別子。
ItemDescription: string

タイトル: Long Description

読取り専用: true

最大長: 4000

取引交渉登録に関連付けられている製品の説明。
ItemName: string

タイトル: Item Description

最大長: 240

取引交渉登録に関連付けられている製品の名前。
ItemNumber: string

タイトル: Item Number

読取り専用: true

最大長: 300

ディール登録の品目の公開一意識別子
LastUpdateDate: string (date-time)

読取り専用: true

取引製品レコードが最後に更新された日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

取引製品レコードを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

取引製品レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

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

タイトル: Description

読取り専用: true

最大長: 1000

ディール登録に関連付けられている製品グループの摘要。
ProductGroupId: integer (int64)

ディール登録に関連付けられている製品グループの一意の識別子。
ProductGroupName: string

タイトル: Name

最大長: 250

取引交渉登録に関連付けられている製品グループの名前。
ProductGroupNumber: string

タイトル: Product Group Number

最大長: 50

ディール登録の製品グループの公開一意識別子
ProductType: string

タイトル: Type

製品または製品グループなどの製品明細タイプ。
数量: number

タイトル: Quantity

製品または製品グループの数量。
RegisteredPrice: number

タイトル: Registered Price

製品の登録価格。
UOMCode: string

タイトル: UOM

最大長: 3

製品数量の単位。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the deal product record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DealId":{
            "type":"integer",
            "description":"The unique identifier of the parent deal registration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The unique identifier of the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DealNumber":{
            "title":"Registration Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the deal registration.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductGroupDescription":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the product group associated with the deal registration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DealProdId":{
            "type":"integer",
            "description":"The unique identifier of the deal registration product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Name",
            "maxLength":250,
            "type":"string",
            "description":"The name of the product group associated with the deal registration.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Long Description",
            "maxLength":4000,
            "type":"string",
            "description":"The description of the product associated with the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DealProdNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the deal registration product.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":300,
            "type":"string",
            "description":"Public Unique Identifier for Item in Deal Registration",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConvExchangeRate":{
            "type":"number",
            "description":"The exchange rate for converting the entered currency to the standard CRM corporate currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemName":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"The name of the product associated with the deal registration.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of the product quantity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the deal product record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group associated with the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConvCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code to which the currency on the deal registration must be converted to. For example, the corporate currency code.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the deal product record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount associated with the product line. The amount equals quantity times the registered price.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the product inventory item associated with the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductType":{
            "title":"Type",
            "type":"string",
            "description":"The product line type, such as product or product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type used to derive the exchange rate between the user entered currency and the CRM corporate currency code associated with the deal registration.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the product or product group.",
            "nullable":true,
            "x-queryable":true
        },
        "RegisteredPrice":{
            "title":"Registered Price",
            "type":"number",
            "description":"The registered price of the product.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupNumber":{
            "title":"Product Group Number",
            "maxLength":50,
            "type":"string",
            "description":"Public Unique Identifier for Product Group in Deal Registration",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the deal product 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 deal product 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

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

ProductTypeVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOO_PROD_TYPE%2CBindLookupCode%3D{ProductType}

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

SalesCatalogExtnProductsLovVA

操作: /crmRestApi/resources/11.13.18.05/products

パラメータ:

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

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

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによってディール製品を取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/deals/300100071405733/child/DealProduct/300100071395748

レスポンス本文の例

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

{
  Amount: 9000
  ConvCurrencyCode: "USD"
  ConvExchangeRate: 1
  ConvRateType: "Corporate"
  CurrencyCode: "USD"
  DealId: 300100071395747
  DealProdId: 300100071395748
  ProductType: "Group"
  ProductGroupId: 100000011628005
  Quantity: 90
  RegisteredPrice: 100
  ProductGroupName: "Electronics"
  ProductGroupDescription: "Electronics contains computers, printers and   
  TVs "
  ...
}

「トップに戻る」