機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 販売プロモーション

すべての販売プロモーションを取得

get

/crmRestApi/resources/11.13.18.05/salesPromotions

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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 : 指定した主キーで販売プロモーションを検索します。
      ファインダ変数:
      • SalesPromotionId; integer; 販売プロモーションの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AdjustmentBasisCode; string; 調整タイプがパーセントの場合の販売促進調整の基準を示すコード。 たとえば、定価や正価です。
    • AdjustmentTypeCode; string; 販売促進調整のタイプを示すコード。 たとえば、明細割引額や明細割引率などです。
    • AdjustmentValue; number;販売プロモーション調整の値。
    • CurrencyCode;文字列。調整タイプが金額の場合の販売プロモーション調整の通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • DeleteFlag; boolean;プロモーション・レコードを削除できるかどうかを示します。 デフォルト値はtrueです。
    • 説明;文字列;販売プロモーションのユーザー定義自由形式の説明。
    • EndDate; string;指定された日付の午前0時より1秒前に、販売プロモーションのアクティブ期間の終了。
    • LastUpdateDate; string; 販売促進レコードが最後に更新された日時。
    • 名前、文字列。販売促進のユーザー定義のフリー・フォーム名。
    • SalesPromotionCode; string; 販売促進のタイプを示すコード。 この値は、販売促進の作成時に生成されます。
    • SalesPromotionId; integer; 販売プロモーションの一意の識別子。
    • StartDate; string;指定された日付の午前0時から1秒後の、販売促進の有効期間の開始。
    • StatusCode; string;販売促進のステータス。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : salesPromotions
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : salesPromotions-item-response
タイプ: object
ソースを表示
  • タイトル: Apply To
    最大長: 30
    デフォルト値: LISTPRICE
    調整タイプがパーセントの場合の販売プロモーション調整の基準を示すコード。 たとえば、定価や正価です。
  • タイトル: Adjustment Type
    最大長: 30
    デフォルト値: LNDISCPERC
    販売プロモーション調整のタイプを示すコード。 たとえば、明細割引額や明細割引率などです。
  • タイトル: Adjustment Value
    販売プロモーション調整の値です。
  • 読取り専用: true
    最大長: 64
    販売プロモーション・レコードを作成したユーザー。
  • 読取り専用: true
    セールス・プロモーション・レコードが作成された日時。
  • タイトル: Currency
    最大長: 15
    調整タイプが金額の場合の販売プロモーション調整の通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • 読取り専用: true
    プロモーション・レコードを削除できるかどうかを示します。 デフォルト値はtrueです。
  • タイトル: Description
    最大長: 1999
    販売プロモーションのユーザー定義自由形式摘要。
  • タイトル: End Date
    指定された日付の午前0時より1秒前に、販売プロモーションのアクティブ期間の終了。
  • タイトル: Last Updated Date
    読取り専用: true
    セールス・プロモーション・レコードが最後に更新された日時。
  • 読取り専用: true
    最大長: 64
    セールス・プロモーション・レコードを最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    セールス・プロモーション・レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Name
    最大長: 150
    販売プロモーションのユーザー定義自由形式名。
  • タイトル: Promotion Code
    最大長: 80
    販売プロモーションのタイプを示すコード。 この値は、販売促進の作成時に生成されます。
  • 販売プロモーションの一意の識別子。
  • タイトル: Start Date
    指定された日付の午前0時から1秒後の、販売プロモーションのアクティブ期間の開始。
  • タイトル: Status
    最大長: 30
    デフォルト値: INACTIVE
    販売プロモーションのステータス。
  • タイトル: Status
    読取り専用: true
    最大長: 80
    販売プロモーション・ステータスの意味。
  • 読取り専用: true
    プロモーション・レコードを更新できるかどうかを示します。 デフォルト値はtrueです。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、すべての販売プロモーションを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesPromotions

レスポンス本文の例

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

{
 items: [13]
  0:{
     SalesPromotionId: 300100089846373
     SalesPromotionCode: "56014333-0377-41a3-a886-c5cdd5adec0d"
     Name: "REST_PRO_61703667926"
     Description: "REST_PRO_61703667926"
     StartDate: "2015-10-22"
     EndDate: "2015-11-22"
     StatusCode: "INACTIVE"
     AdjustmentTypeCode: "LNDISCPERC"
     AdjustmentValue: null
     AdjustmentBasisCode: "LISTPRICE"
     CurrencyCode: null
     ...
}
「トップに戻る」