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

製品関係詳細の取得

get

/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}

リクエスト

パス・パラメータ

ProdGroupId(required): integer(int64)

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

製品グループ品目のメンバーシップの一意の識別子。

問合せパラメータ

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のデフォルト・バージョンを選択します。

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

タイプ: object

ソースを表示

ActiveFlag: boolean

タイトル: Active

最大長: 1

デフォルト値: true

アイテムがグループ内でアクティブかどうかを示します。デフォルト値はtrueです。
Description: string

タイトル: Product

読取り専用: true

最大長: 240

品目の摘要。
DisplayOrderNum: integer (int64)

タイトル: Display Sequence

製品グループ内の品目の表示順序を手動で設定します。
EligibilityRules: array EligibilityRules

タイトル: EligibilityRules

適格ルール・リソースは、様々な適格ルールを表示、作成、更新および削除するために使用され、実行時に選択可能な製品が少数のみになります。アイテムごとに、ルールが特定の国に対して有効か、全ての国に対して有効かを指定する資格ルールを1つ以上追加できます。
EndDate: string (date-time)

タイトル: Effective to Date

アイテムが有効でない日付。
InventoryItemId: integer (int64)

タイトル: Inventory Item ID

在庫品目の一意の識別子。
InvOrgId: integer (int64)

品目の在庫組織の一意の識別子。
links: array Links

タイトル: Links

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

タイトル: Description

読取り専用: true

最大長: 4000

アイテムの詳細な説明。
ParPGReferenceNumber: string

タイトル: Parent Product Group Reference Number

最大長: 50

製品の並列度。
ProdGroupId: integer (int64)

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

製品グループ品目のメンバーシップの一意の識別子。
ProductNumber: string

タイトル: Product Number

読取り専用: true

最大長: 300

品目の名前。
StartDate: string (date-time)

タイトル: Effective from Date

グループ内でアイテムがアクティブである開始日。

{
    "type":"object",
    "properties":{
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Product",
            "maxLength":240,
            "type":"string",
            "description":"The description of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The unique identifier of an inventory organization for an item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of an inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParPGReferenceNumber":{
            "title":"Parent Product Group Reference Number",
            "maxLength":50,
            "type":"string",
            "description":"The par pgreferenceurations of the product.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductNumber":{
            "title":"Product Number",
            "maxLength":300,
            "type":"string",
            "description":"The name of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProdGroupItemsId":{
            "type":"integer",
            "description":"The unique identifier of the membership of the product group item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the item is active in the group. The default value is true.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date after which the item is not active.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date from which the item is active in the group.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "EligibilityRules":{
            "title":"EligibilityRules",
            "type":"array",
            "description":"The eligibility rules resource is used to view, create, update, and delete the various eligibility rules so that only a few products are available for selection at run time. For each item, you can add one or more eligibility rules specifying whether a rule is valid for a particular country or for all countries.",
            "items":{
                "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupProductSetup-EligibilityRules-item-response"
            }
        },
        "DisplayOrderNum":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Manually set display order for items in a product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Description",
            "maxLength":4000,
            "type":"string",
            "description":"The detailed description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

タイプ: array

タイトル: EligibilityRules

適格ルール・リソースは、様々な適格ルールを表示、作成、更新および削除するために使用され、実行時に選択可能な製品が少数のみになります。アイテムごとに、ルールが特定の国に対して有効か、全ての国に対して有効かを指定する資格ルールを1つ以上追加できます。

ソースを表示

Array of: object setupSalesCatalogs-ProductGroupProductSetup-EligibilityRules-item-response

{
    "title":"EligibilityRules",
    "type":"array",
    "description":"The eligibility rules resource is used to view, create, update, and delete the various eligibility rules so that only a few products are available for selection at run time. For each item, you can add one or more eligibility rules specifying whether a rule is valid for a particular country or for all countries.",
    "items":{
        "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupProductSetup-EligibilityRules-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"
    }
}

ネストされたスキーマ : setupSalesCatalogs-ProductGroupProductSetup-EligibilityRules-item-response

タイプ: object

ソースを表示

CountryName: string

タイトル: Country

各地理識別子に対応する国名。
EligibilityRuleId: integer (int64)

各適格ルールに対応する一意の識別子。
EndDate: string (date-time)

タイトル: Effective to Date

ルールが終了する日付。
GeographyCode: string

タイトル: Country Code

最大長: 30

デフォルト値: All

地理コード。
GeographyId: integer (int64)

タイトル: Geography ID

国の地理の一意の識別子。
InventoryItemId: integer (int64)

在庫品目の一意の識別子。
InvOrgId: integer (int64)

タイトル: Inventory Organization ID

在庫組織の一意の識別子。
links: array Links

タイトル: Links

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

タイトル: Parent Product Group Reference Number

最大長: 50

代替参照番号。
ProdGroupId: integer (int64)

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

読取り専用: true

最大長: 300

製品番号。
RuleType: string

タイトル: Rule Type

最大長: 30

適格ルールのタイプ。たとえば、AVAILABLEやNOTAVAILABLEです。
StartDate: string (date-time)

タイトル: Effective from Date

ルールがアクティブになる日付。

{
    "type":"object",
    "properties":{
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GeographyCode":{
            "title":"Country Code",
            "maxLength":30,
            "type":"string",
            "description":"The geography code.",
            "nullable":true,
            "default":"All",
            "x-hints":{
                "dependencies":[
                    "GeographyId"
                ]
            },
            "x-queryable":true
        },
        "InvOrgId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"The unique identifier of the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GeographyId":{
            "title":"Geography ID",
            "type":"integer",
            "description":"The unique identifier of the geography of a country.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CountryName":{
            "title":"Country",
            "type":"string",
            "description":"The name of the country corresponding to each geography identifier.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParPGReferenceNumber":{
            "title":"Parent Product Group Reference Number",
            "maxLength":50,
            "type":"string",
            "description":"The alternate reference number.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleType":{
            "title":"Rule Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of eligibility rule. For example, AVAILABLE or NOTAVAILABLE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProductNumber":{
            "maxLength":300,
            "type":"string",
            "description":"The product number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date when the rule ends.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date when the rule becomes active.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "EligibilityRuleId":{
            "type":"integer",
            "description":"The unique identifier corresponding to each eligibility rule.",
            "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"
            }
        }
    }
}

ネストされたスキーマ : リンク

タイプ: 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."
        }
    }
}

リンク

EligibilityRules

操作: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}/child/EligibilityRules

パラメータ:

ProdGroupId: $request.path.ProdGroupId
ProdGroupItemsId: $request.path.ProdGroupItemsId

(EligibilityRulesのリソース)

トップに戻る

例:

cURLコマンド

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

curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788637/child/ProductGroupProductSetup/300100074788641

レスポンス本文の例

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

{
  "ProdGroupItemsId": 300100074788641,
  "StartDate": "2016-06-09T07:00:00+00:00",
  "ProdGroupId": 300100074788637,
  "InventoryItemId": 999997500678267,
  "InvOrgId": 204,
  "DisplayOrderNum": null,
  "ActiveFlag": true,
  "EndDate": null,
  "Description": " Oracle Utilities CIS Adapter, Generic",
  "LongDescription": "License/Applications/Vertical ERP Applications/Oracle Utilities Applications/Oracle Utilities Network Management/Oracle Utilities Network Management - Other/ Oracle Utilities CIS Adapter, Generic",
  "ProductNumber": "QP8",
  ...
}

「トップに戻る」