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

属性値の更新

patch

/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup/{ProdGrpAtvalId}

リクエスト

パス・パラメータ

ProdGroupId(required): integer(int64)

製品グループの一意の識別子。
ProdGrpAttrId(required): integer(int64)

製品グループ属性値の一意の識別子。
ProdGrpAtvalId(required): integer(int64)

製品グループ属性値の一意の識別子。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

AttrValueName: string

タイトル: Display

最大長: 150

属性値の名前。
AttrValueText: string

タイトル: Internal Value

最大長: 150

属性値に対応するテキスト。
CurrencyCode: string

タイトル: Currency

最大長: 15

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

タイトル: Display Sequence

属性ドメインの表示順序を手動で設定します。
MaxValueNum: number

タイトル: Maximum Value

範囲内の最大数値。
MinValueNum: number

タイトル: Minimum Value

範囲内の最小数値。
ProdGroupId: integer (int64)

製品グループの一意の識別子。
ProdGrpAtvalId: integer (int64)

製品グループ属性値の一意の識別子。
ValueId: integer (int64)

タイトル: Value

値の一意の識別子。

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code of the product's registered price and 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, Manage Currency Profile Options task.",
            "nullable":true
        },
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DisplayOrderNum":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The manually set display order for attribute domain.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MaxValueNum":{
            "title":"Maximum Value",
            "type":"number",
            "description":"The maximum numeric value in a range.",
            "nullable":true,
            "x-hints":{
                "precision":22,
                "scale":7
            }
        },
        "ProdGrpAtvalId":{
            "type":"integer",
            "description":"The unique identifier of the product group attribute value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AttrValueText":{
            "title":"Internal Value",
            "maxLength":150,
            "type":"string",
            "description":"The text corresponding to attribute value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MinValueNum":{
            "title":"Minimum Value",
            "type":"number",
            "description":"The minimum numeric value in a range.",
            "nullable":true,
            "x-hints":{
                "precision":22,
                "scale":7
            }
        },
        "ValueId":{
            "title":"Value",
            "type":"integer",
            "description":"The unique identifier of the value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AttrValueName":{
            "title":"Display",
            "maxLength":150,
            "type":"string",
            "description":"The name of the attribute value.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : setupSalesCatalogs-ProductGroupAttributeSetup-ProductGroupAttributeValueSetup-item-response

タイプ: object

ソースを表示

AttrValueName: string

タイトル: Display

最大長: 150

属性値の名前。
AttrValueText: string

タイトル: Internal Value

最大長: 150

属性値に対応するテキスト。
CurrencyCode: string

タイトル: Currency

最大長: 15

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

タイトル: Display Sequence

属性ドメインの表示順序を手動で設定します。
links: array Links

タイトル: Links

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

タイトル: Maximum Value

範囲内の最大数値。
MinValueNum: number

タイトル: Minimum Value

範囲内の最小数値。
ProdGroupId: integer (int64)

製品グループの一意の識別子。
ProdGrpAtvalId: integer (int64)

製品グループ属性値の一意の識別子。
ValueId: integer (int64)

タイトル: Value

値の一意の識別子。

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code of the product's registered price and 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, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisplayOrderNum":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The manually set display order for attribute domain.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MaxValueNum":{
            "title":"Maximum Value",
            "type":"number",
            "description":"The maximum numeric value in a range.",
            "nullable":true,
            "x-hints":{
                "precision":22,
                "scale":7
            },
            "x-queryable":true
        },
        "ProdGrpAtvalId":{
            "type":"integer",
            "description":"The unique identifier of the product group attribute value.",
            "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"
            }
        },
        "AttrValueText":{
            "title":"Internal Value",
            "maxLength":150,
            "type":"string",
            "description":"The text corresponding to attribute value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MinValueNum":{
            "title":"Minimum Value",
            "type":"number",
            "description":"The minimum numeric value in a range.",
            "nullable":true,
            "x-hints":{
                "precision":22,
                "scale":7
            },
            "x-queryable":true
        },
        "ValueId":{
            "title":"Value",
            "type":"integer",
            "description":"The unique identifier of the value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttrValueName":{
            "title":"Display",
            "maxLength":150,
            "type":"string",
            "description":"The name of the attribute value.",
            "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."
        }
    }
}

トップに戻る

例:

cURLコマンド

次の例は、cURLを使用してRESTリソースに対してパッチ・リクエストを発行することによって属性値を更新する方法を示しています。

curl --user sales_cloud_user -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788637/child/ProductGroupAttributeSetup/300100074788648/child/ProductGroupAttributeValueSetup/300100074788664

リクエスト本文の例

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

{
   "AttrValueName": "Test",
  "AttrValueText": "123",
  "CurrencyCode": null,
  "MaxValueNum": null,
  "MinValueNum": null,
  "ValueId": null,
  "DisplayOrderNum": 2
}

レスポンス本文の例

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

{
  "AttrValueName": "Test",
  "AttrValueText": "123",
  "CurrencyCode": null,
  "MaxValueNum": null,
  "MinValueNum": null,
  "ProdGroupId": 300100074788637,
  "ProdGrpAtvalId": 300100074788664,
  "ValueId": null,
  "DisplayOrderNum": 2,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788637/child/ProductGroupAttributeSetup/300100074788648/child/ProductGroupAttributeValueSetup/300100074788664",
      "name": "ProductGroupAttributeValueSetup",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788637/child/ProductGroupAttributeSetup/300100074788648/child/ProductGroupAttributeValueSetup/300100074788664",
      "name": "ProductGroupAttributeValueSetup",
      "kind": "item"
    },
    {
      "rel": "parent",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788637/child/ProductGroupAttributeSetup/300100074788648",
      "name": "ProductGroupAttributeSetup",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788637/child/ProductGroupAttributeSetup/300100074788648/child/ProductGroupAttributeValueSetup/300100074788664/lov/TranslatableIndependentValueSetValuePVO",
      "name": "TranslatableIndependentValueSetValuePVO",
      "kind": "collection"
    }
  ]
}

「トップに戻る」