機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 営業リード
  4. 営業リード製品

すべての営業リード製品の取得

get

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklProdAssoc1

リクエスト

パス・パラメータ
  • これは、営業リード・リソースの複合キーを構成し、営業リードのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、営業リードの特定のインスタンスに移動してハッシュ・キーを取得するために、営業リード・コレクション・リソースを問い合せる必要があります。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

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

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PrimaryKey : 指定されたLeadProduct識別子でリード製品を検索します。
      ファインダ変数:
      • LeadProductId; integer;リード製品の一意の識別子。
    • ProdAssocNumberRF : 指定された見込み客製品番号を持つ見込み客製品を検索します。
      ファインダ変数:
      • LeadProductNumber; string.
    • ProductGroupRF : 指定されたリード番号および製品グループIDを持つリード製品を検索
      ファインダ変数:
      • LeadNumber; string; リソースの問合せに使用されるパラメータ。
      • ProductGroupId; string;製品グループの一意の識別子。
    • ProductRF : 指定されたリード番号、在庫品目IDおよび組織IDを持つリード製品を検索します。
      ファインダ変数:
      • InventoryItemId; string;インベントリ・アイテムの一意の識別子。
      • LeadNumber; string; リソースの問合せに使用されるパラメータ。
      • OrganizationId; string;組織の一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • 金額、数値、営業リード製品に関連付けられた金額。
    • AverageTimeToClose; number;この営業リード製品の平均クローズ時間。
    • ConflictId; integer; この値により、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。
    • CreatedBy; string; この営業リード製品を作成したユーザー。
    • CreationDate; string; この営業リード製品が作成された日時。
    • CurrencyCode; string; リード製品明細金額に関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 この属性の値は、「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用してレビューおよび更新できます。
    • 説明;文字列;製品がリードに関連付けられている製品の説明。
    • EstimatedUnitPrice; number;このリード製品の見積単価。
    • InventoryItemId; integer; リード製品に関連付けられた一意の在庫品目識別子。
    • ItemNumber; string;参照される在庫アイテムの代替キー。
    • LastUpdateDate; string;営業リード製品の最終更新日時。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; 営業リード製品を最後に更新したユーザー。
    • LeadId; integer; この営業リード製品の営業リードの一意の識別子。
    • LeadNumber; string;リードの代替の一意の識別子。
    • LeadProductId; integer; 現在の営業リード製品の一意の識別子。
    • LeadProductNumber; string;リード製品の代替キー。
    • LongDescription; string; 営業リード製品の詳細な説明。
    • OrganizationId; integer; このリード製品に関連付けられた一意の在庫組織識別子。
    • PrimaryFlag; boolean。この製品がこのリードのプライマリ製品であるかどうかを示します。
    • ProductGroupDescription; string;製品グループの簡単な説明。
    • ProductGroupId; integer; 製品グループの一意の識別子。
    • ProductGroupName; string; 営業リード製品リソースに関連付けられた製品グループの名前。
    • ProductGroupReferenceNumber; string;参照される製品グループの代替キー。
    • 数量;番号;リードのこの製品に対して識別される製品数量。
    • UOMCode; string; この営業リード製品ラインに関連付けられている単位。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : leads-MklProdAssoc1
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : leads-MklProdAssoc1-item-response
タイプ: object
ソースを表示
  • タイトル: Amount
    営業リード製品に関連付けられた金額。
  • タイトル: Average Time to Close
    この営業リード製品の平均クローズ時間。
  • タイトル: Conflict Identifier
    デフォルト値: 0
    この値によって、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    この営業リード製品を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    この営業リード製品が作成された日時。
  • タイトル: Currency
    最大長: 15
    リード製品明細金額に関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 この属性の値は、「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用してレビューおよび更新できます。
  • タイトル: Item Description
    最大長: 240
    製品が見込み客に関連付けられている製品説明。
  • タイトル: Estimated Unit Price
    このリード製品の見積単価。
  • タイトル: Inventory Number
    リード製品に関連付けられた一意の在庫品目識別子。
  • タイトル: Inventory Item Number
    読取り専用: true
    最大長: 300
    参照在庫品目の代替キー。
  • タイトル: Last Updated Date
    読取り専用: true
    営業リード製品の最終更新日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    営業リード製品を最後に更新したユーザー。
  • タイトル: Last Updated Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • タイトル: Lead ID
    この営業リード製品の営業リードの一意の識別子。
  • タイトル: Lead Number
    最大長: 30
    リードの代替一意識別子。
  • タイトル: Lead Product ID
    現在の営業リード製品の一意の識別子。
  • タイトル: Lead Product Number
    最大長: 30
    見込み客製品の代替キー。
  • Links
  • タイトル: Long Description
    読取り専用: true
    最大長: 4000
    営業リード製品の詳細な説明。
  • タイトル: Organization
    このリード製品に関連付けられた一意の在庫組織識別子。
  • タイトル: Primary
    最大長: 1
    この製品がこのリードのプライマリ製品であるかどうかを示します。
  • タイトル: Product Group Description
    読取り専用: true
    最大長: 1000
    製品グループの簡単な説明。
  • タイトル: Product Group ID
    製品グループの一意の識別子。
  • タイトル: Product Group Name
    最大長: 250
    営業リード製品リソースに関連付けられている製品グループの名前。
  • タイトル: Product Group Reference Number
    最大長: 50
    参照製品グループの代替キー。
  • タイトル: Product Type
    製品のタイプ(品目または製品グループなど)。
  • タイトル: Quantity
    リードのこの製品に対して識別される製品数量。
  • タイトル: UOM
    最大長: 3
    この営業リード製品明細に関連付けられた単位。
トップに戻る

例:

cURLコマンド

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

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklProdAssoc1

レスポンス本文の例

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

{
  "items": [
    {
      "LeadProductId": 300100092582201,
      "LeadId": 300100092582093,
      "OrganizationId": null,
      "CurrencyCode": "USD",
      "EstimatedUnitPrice": null,
      "InventoryItemId": null,
      "PrimaryFlag": true,
      "ProductGroupId": 999997826071175,
      "Quantity": null,
      "UOMCode": null,
      "Description": null,
      "CreatedBy": "MHoope",
      "CreationDate": "2016-11-07T04:24:54-08:00",
      "LastUpdatedBy": "MHoope",
      "LastUpdateDate": "2016-11-07T04:25:06-08:00",
      "AverageTimeToClose": null,
      "ProductGroupName": " Activity Hub B2C",
      "ProductGroupDescription": "License/Applications/CRM Applications/Siebel CRM Applications/Master Data Management - Customer Hub for B2C/ Activity Hub B2C",
      "LongDescription": null,
      "Amount": null,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklProdAssoc1/300100092582201",
          "name": "MklProdAssoc1",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
          }
        },
.........
      ]
    }
  ],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklProdAssoc1",
      "name": "MklProdAssoc1",
      "kind": "Collection"
    }
  ]
}
「トップに戻る」