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

製品グループの取得

get

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/productGroups/{ProdGroupId}

リクエスト

パス・パラメータ

ChildRevenueUniqID(required): string

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

商談の一意の代替識別子。
ProdGroupId(required): integer

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

問合せパラメータ

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

ルート・スキーマ : opportunities-ChildRevenue-productGroups-item-response

タイプ: object

ソースを表示

Description: string

タイトル: Description

読取り専用: true

最大長: 1000

製品グループのユーザー指定の摘要。
DisplayName: string

タイトル: Name

読取り専用: true

最大長: 255

製品グループの名前。
LastUpdateDate: string

タイトル: Last Updated Date

読取り専用: true

製品グループが最後に更新された日付。
links: array Links

タイトル: Links

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

読取り専用: true

製品グループに関連付けられたモデル構成属性。
ModelName: string

読取り専用: true

製品グループに関連付けられたモデル名。
ProdGroupId: integer

タイトル: Product Group ID

読取り専用: true

製品グループの一意の識別子。
QuotableFlag: boolean

タイトル: Quotable

読取り専用: true

製品グループが見積可能かどうかを示します。
ReferenceNumber: string

タイトル: Reference Number

読取り専用: true

製品グループの参照番号。

{
    "type":"object",
    "properties":{
        "ProdGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The user-provided description of the product group.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ModelName":{
            "type":"string",
            "description":"The model name associated with the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ModelConfigAttributes":{
            "type":"string",
            "description":"The model configuration attributes associated with the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceNumber":{
            "title":"Reference Number",
            "type":"string",
            "description":"The reference number of the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuotableFlag":{
            "title":"Quotable",
            "type":"boolean",
            "description":"Indicates whether a product group is quotable.",
            "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"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the product group was last updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

タイプ: 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を使用してRESTリソースに対する取得リクエストを発行することによって、製品グループを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_332708/child/ChildRevenue/300100111705696/child/productGroups/300100072887690

レスポンス本文の例

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

{
  "PrimaryOrganizationId" : 204,
  "CurrencyCode" : "USD",
  "SalesMethodId" : 100000012430001,
  "SalesStageId" : 100000012430007,
  "Name" : "Major Server Upgrade",
  "OptyId" : 300100111705686,
  "OptyNumber" : "CDRM_332708",
  "OwnerResourcePartyId" : 3807,
  "KeyContactId" : 100000016105039,
  "PrimaryRevenueId" : 300100111705687,
  "SalesMethod" : "Standard Sales Process",
  "SalesStage" : "01 - Qualification",
  "DescriptionText" : "Looking for the Right Contacts, Characteristics, Determining the Need, Budget and Sponsor",
  "AverageDaysAtStage" : 30,
  "MaximumDaysInStage" : 800,
  "PhaseCd" : "QUALIFICATION-DISCOVERY",
  "ForecastOverrideCode" : "CRITERIA",
  "SalesChannelCd" : "ZPM_DIRECT_CHANNEL_TYPES",
}

「トップに戻る」