機械翻訳について

ジャンプ先

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

価格表品目の更新

patch

/crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/PriceBookItem/{priceBookHeaders_PriceBookItem_Id}

リクエスト

パス・パラメータ

• priceBookHeaders_Id(required): string
  このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
• priceBookHeaders_PriceBookItem_Id(required): string
  このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• CurrencyCode: string
  最大長: 15

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

  価格台帳で選択された品目の一意の識別子。
• InvOrgId: integer (int64)
  価格台帳で選択された品目に関連付けられた在庫組織の一意の識別子。
• ItemDescription: string
  タイトル: Name

  価格台帳品目の簡単な摘要。
• ItemExternalKey: string
  タイトル: External Key

  最大長: 120

  価格台帳品目の外部キー値。
• ItemExternalSource: string
  タイトル: External Source

  最大長: 120

  デフォルト値: PB_LINE

  価格台帳品目の外部キーのソース。
• ListPrice: number
  タイトル: List Price

  デフォルト値: 0

  品目の価格。
• PricebookId: integer (int64)
  価格台帳の一意の識別子。
• PriceUOMCode: string
  タイトル: UOM

  最大長: 30

  品目の単位。

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency of the price book amount. 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.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceUOMCode":{
            "title":"UOM",
            "maxLength":30,
            "type":"string",
            "description":"The unit of measurement of the item.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemExternalSource":{
            "title":"External Source",
            "maxLength":120,
            "type":"string",
            "description":"The source for the external key of the price book item.",
            "nullable":true,
            "default":"PB_LINE",
            "x-queryable":true
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The unique identifier of the inventory organization associated with the item selected in the price book.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemExternalKey":{
            "title":"External Key",
            "maxLength":120,
            "type":"string",
            "description":"The external key value for the price book item.",
            "nullable":true,
            "x-queryable":true
        },
        "InvItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the item selected in the price book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The price of the item.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Name",
            "type":"string",
            "description":"A brief description of the price book item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PricebookId":{
            "type":"integer",
            "description":"The unique identifier of the price book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : priceBookHeaders-PriceBookItem-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  レコードが作成された日付。
• CurrencyCode: string
  最大長: 15

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

  価格台帳で選択された品目の一意の識別子。
• InvOrgId: integer (int64)
  価格台帳で選択された品目に関連付けられた在庫組織の一意の識別子。
• ItemDescription: string
  タイトル: Name

  価格台帳品目の簡単な摘要。
• ItemExternalKey: string
  タイトル: External Key

  最大長: 120

  価格台帳品目の外部キー値。
• ItemExternalSource: string
  タイトル: External Source

  最大長: 120

  デフォルト値: PB_LINE

  価格台帳品目の外部キーのソース。
• ItemNumber: string
  読取り専用: true

  最大長: 300

  価格台帳金額の品目。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_ITEMで定義されます。 「設定およびメンテナンス」作業領域を使用して、プロファイル・オプションをレビューおよび更新します。
• LastUpdateDate: string (date-time)
  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

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

  最大長: 32

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

  リソース・インスタンスに関連付けられたリンク関係。
• ListPrice: number
  タイトル: List Price

  デフォルト値: 0

  品目の価格。
• PricebookCode: string
  タイトル: Price Book Code

  最大長: 80
• PricebookId: integer (int64)
  価格台帳の一意の識別子。
• PricebookItemId: integer (int64)
  価格台帳品目の一意の識別子。
• PriceUOMCode: string
  タイトル: UOM

  最大長: 30

  品目の単位。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemExternalSource":{
            "title":"External Source",
            "maxLength":120,
            "type":"string",
            "description":"The source for the external key of the price book item.",
            "nullable":true,
            "default":"PB_LINE",
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The unique identifier of the inventory organization associated with the item selected in the price book.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricebookCode":{
            "title":"Price Book Code",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "PricebookItemId":{
            "type":"integer",
            "description":"The unique identifier of the price book item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The price of the item.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Name",
            "type":"string",
            "description":"A brief description of the price book item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency of the price book amount. 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.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceUOMCode":{
            "title":"UOM",
            "maxLength":30,
            "type":"string",
            "description":"The unit of measurement of the item.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"The item of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_ITEM. Review and update the profile option using the Setup and Maintenance work area.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemExternalKey":{
            "title":"External Key",
            "maxLength":120,
            "type":"string",
            "description":"The external key value for the price book item.",
            "nullable":true,
            "x-queryable":true
        },
        "InvItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the item selected in the price book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date 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
        },
        "PricebookId":{
            "type":"integer",
            "description":"The unique identifier of the price book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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."
        }
    }
}

リンク

SalesCatalogExtnProductsLovVA

操作: /crmRestApi/resources/11.13.18.05/products

パラメータ:

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

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: ItemDescription;ターゲット属性: 名前
• 表示属性: 名前

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、価格表アイテムを更新する方法を示しています。

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{

"ListPrice" : 23.45

}

レスポンス本文の例

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

{
  "PricebookItemId" : 300100062008005,
  "PricebookId" : 300100062008000,
  "InvItemId" : 7975,
  "ItemDescription" : "Laptop Upgrade Board",
  "InvOrgId" : 204,
  "ListPrice" : 23.45,
  "ObjectVersionNumber" : 2,
  "CreatedBy" : "SALES_ADMIN",
  "CreationDate" : "2015-03-26T03:59:43-08:00",
  "LastUpdateDate" : "2016-03-01T06:14:48-08:00",
  "LastUpdateLogin" : "2CF7673ED2203829E0531A78F00A3DEE",
  "LastUpdatedBy" : "SALES_ADMIN",
  "CurrencyCode" : "USD",
  "PriceUOMCode" : "Ea",
  "links" : [ {
    ...
  } ]
}

「トップに戻る」