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

機械翻訳について

販売プロモーションの取得

get

/crmRestApi/resources/11.13.18.05/salesPromotions/{SalesPromotionId}

リクエスト

パス・パラメータ

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

ルート・スキーマ : salesPromotions-item-response

タイプ: object

ソースを表示

AdjustmentBasisCode: string

タイトル: Apply To

最大長: 30

デフォルト値: LISTPRICE

調整タイプがパーセントの場合の販売プロモーション調整の基準を示すコード。たとえば、定価や正価です。
AdjustmentTypeCode: string

タイトル: Adjustment Type

最大長: 30

デフォルト値: LNDISCPERC

販売プロモーション調整のタイプを示すコード。たとえば、明細割引額や明細割引率などです。
AdjustmentValue: number

タイトル: Adjustment Value

販売プロモーション調整の値です。
CreatedBy: string

読取り専用: true

最大長: 64

販売プロモーション・レコードを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

セールス・プロモーション・レコードが作成された日時。
CurrencyCode: string

タイトル: Currency

最大長: 15

調整タイプが金額の場合の販売プロモーション調整の通貨コード。この属性は、CRM拡張フレームワークで使用されます。有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
DeleteFlag: boolean

読取り専用: true

プロモーション・レコードを削除できるかどうかを示します。デフォルト値はtrueです。
Description: string

タイトル: Description

最大長: 1999

販売プロモーションのユーザー定義自由形式摘要。
EndDate: 文字列(日付)

タイトル: End Date

指定された日付の午前0時より1秒前に、販売プロモーションのアクティブ期間の終了。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

セールス・プロモーション・レコードが最後に更新された日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

セールス・プロモーション・レコードを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

セールス・プロモーション・レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

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

タイトル: Name

最大長: 150

販売プロモーションのユーザー定義自由形式名。
SalesPromotionCode: string

タイトル: Promotion Code

最大長: 80

販売プロモーションのタイプを示すコード。この値は、販売促進の作成時に生成されます。
SalesPromotionId: integer (int64)

販売プロモーションの一意の識別子。
StartDate: 文字列(日付)

タイトル: Start Date

指定された日付の午前0時から1秒後の、販売プロモーションのアクティブ期間の開始。
StatusCode: string

タイトル: Status

最大長: 30

デフォルト値: INACTIVE

販売プロモーションのステータス。
StatusMeaning: string

タイトル: Status

読取り専用: true

最大長: 80

販売プロモーション・ステータスの意味。
UpdateFlag: boolean

読取り専用: true

プロモーション・レコードを更新できるかどうかを示します。デフォルト値はtrueです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the sales promotion record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the sales promotion record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the sales promotion record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":1999,
            "type":"string",
            "description":"The user-defined free form description of the sales promotion.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesPromotionId":{
            "type":"integer",
            "description":"The unique identifier of the sales promotion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end of the active period for the sales promotion, one second before midnight on the date indicated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the sales promotion.",
            "nullable":false,
            "default":"INACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the promotion record can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":150,
            "type":"string",
            "description":"The user-defined free form name of the sales promotion.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start of the active period for the sales promotion, one second after midnight on the date indicated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentTypeCode":{
            "title":"Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the sales promotion adjustment. For example, Line Discount Amount or Line Discount Percent.",
            "nullable":false,
            "default":"LNDISCPERC",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code of the sales promotion adjustment when the adjustment type is 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-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the sales promotion status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the promotion record can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AdjustmentValue":{
            "title":"Adjustment Value",
            "type":"number",
            "description":"The value of the sales promotion adjustment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AdjustmentTypeCode"
                ]
            },
            "x-queryable":true
        },
        "SalesPromotionCode":{
            "title":"Promotion Code",
            "maxLength":80,
            "type":"string",
            "description":"The code indicating the type of the sales promotion. This value is generated when a sales promotion is created.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AdjustmentBasisCode":{
            "title":"Apply To",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the basis of the sales promotion adjustment when the adjustment type is Percent. For example List Price or Net Price.",
            "nullable":true,
            "default":"LISTPRICE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the sales promotion record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the sales promotion record.",
            "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."
        }
    }
}

リンク

AdjustmentTypeSearchVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_QSC_PROMO_ADJ_TYPE

明細割引額や明細割引率など、販売プロモーション調整のタイプの値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: AdjustmentTypeCode;ターゲット属性: LookupCode
表示属性: 意味

ApplyOnSearchVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_QSC_PROMO_ADJ_APPLON

定価や正価など、調整タイプがパーセントの場合の販売プロモーション調整の基準の値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: AdjustmentBasisCode;ターゲット属性: LookupCode
表示属性: 意味

StatusSearchLovVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_QSC_PROMO_STATUS

アクティブまたは非アクティブなど、販売プロモーションのステータスの値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: StatusCode;ターゲット属性: LookupCode
表示属性: 意味

トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

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

{
  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"
  ...
}

「トップに戻る」