ポイント・タイプの取得
get
/crmRestApi/resources/11.13.18.05/loyPointTypesLOV/{LoyAttrdefnBId}
リクエスト
パス・パラメータ
- LoyAttrdefnBId(required): integer(int64)
ロイヤルティ属性の主キー。 Oracle Loyalty Cloudは、この属性値を生成します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。
問合せパラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : loyPointTypesLOV-item-response
タイプ:
ソースを表示
object
-
AccntActCode: string
タイトル:
Activity
最大長:30
ポイント・タイプ・アカウント・アクティビティ・コード。 このオプションが指定されている場合、ポイント・タイプに指定された期間内にタイプのアクティビティがない場合、ポイントは失効します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
ActiveFlag: boolean
タイトル:
Active
最大長:1
デフォルト値:false
作成されたポイント・タイプ属性を使用できるようにするかどうかを指定するブール属性。 デフォルト値はNです。 この属性に関連する依存関係または制限はありません。 -
AttrDefnId: integer (int64)
タイトル:
Attribute Definition ID
pointType、メンバー、トランザクションなどの属性タイプに対応するロイヤルティ属性定義の主キー値。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
AttrTypeCode: string
タイトル:
Attribute Type Code
最大長:30
ポイント・タイプ属性タイプ・コード。 この属性には、フィールド、ポイント合計などの属性のタイプが反映されます。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
BusSvcName: string
タイトル:
Business Service Name
最大長:75
ビジネス基準の評価のプロモーションで呼び出すことができる外部ビジネス・サービス。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
CancelActnCode: string
タイトル:
Cancel Action Code
最大長:30
トランザクション取消時に適用する必要がある処理の指定。 受け入れられる値はそのまま残す(選択した場合、トランザクションの取消時に属性の値が同じままになる)、元に戻すなどです。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
CostPERPoint: number
タイトル:
Cost per Point
各ポイントのコスト。 ポイントと通貨の組合せに対して製品の引換を許可する場合は、1ポイントの現金値として割り当てる金額を入力します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
プロモーション属性を作成したロイヤルティ・ユーザー。 Oracle Loyalty Cloudは、新しいプロモーション属性の作成時にこの属性値を生成します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
ポイント・タイプ属性が作成された日付。 Oracle Loyalty Cloudは、新しいポイント・タイプ属性の作成時にこの属性値を生成します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
CurrencyCode: integer (int64)
タイトル:
Currency
トランザクションで使用される通貨。 許容される値は、INR、USDおよびGBPです。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
CurrencyExchDt: 文字列(日付)
タイトル:
Currency Exchange Date
ポイント・タイプ属性通貨換算が実行される日付。 この属性には、ポイント・タイプ属性の作成中に通貨交換の日付が表示されます。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
DataTypeCode: string
タイトル:
Data Type
最大長:30
ポイント・タイプ属性のデータ型コードは、属性が文字列か数値かなどを示します。 トランザクションの取消し中、Oracle Loyalty Cloudは、データ型名に基づいて特定の取消しアクションを適用する必要があるかどうかを決定します。 たとえば、変更の取消処理は数値データ型に対してのみ使用できます。 元に戻す処理は、文字列データ型と数値データ型に対してのみ使用でき、すべてのデータ型に対してそのまま残す処理を使用できます。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
DataTypeMeaning: string
タイトル:
Data Type Meaning
読取り専用:true
データ型意味属性は、属性が文字列か数値かなどを示します。 トランザクションの取消し中、Oracle Loyalty Cloudは、データ型名に基づいて特定の取消しアクションを適用する必要があるかどうかを決定します。 たとえば、変更の取消処理は数値データ型に対してのみ使用できます。 元に戻す処理は、文字列データ型と数値データ型に対してのみ使用でき、すべてのデータ型に対してそのまま残す処理を使用できます。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
DefaultValue: string
タイトル:
Default Value
最大長:75
属性がメンバーに対して初めて作成されるときに使用されるデフォルト値。 この属性に関連する依存関係または制限はありません。 -
DescriptionText: string
タイトル:
Description
最大長:1000
ポイント・タイプに関連する追加詳細。 この属性に関連付けられたデフォルト値、依存関係はありません。 -
DisplayFlag: boolean
タイトル:
Display
最大長:1
デフォルト値:true
プロモーション基準で使用できるように、ポイント・タイプ属性を表示するかどうかを示すブール属性。 デフォルト値は「Y」です。 この属性に関連する依存関係または制限はありません。 -
DisplayName: string
タイトル:
Name
最大長:30
ポイント・タイプ属性の表示名で、ユーザーに表示されます。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
DynamicFlag: boolean
タイトル:
Dynamic
最大長:1
デフォルト値:false
プロモーション基準で使用される別の属性に基づいて属性値が動的に計算されるかどうかを示すブール属性。 基準では、属性と値を比較したり、属性を別の属性と比較できます。 デフォルト値はNです。 この属性に関連する依存関係または制限はありません。 -
ExpiryAdjustmentMeaning: string
読取り専用:
true
クレジットの時点で作成された失効日と販売価格が異なるポイントのブロックです。 メンバーがポイントを計上すると、これらのポイント・ブロックは価格設定ルールに基づいて借方に記入され、最も早い失効日が最初に借方に記入されます。 ポイント残高の貸方記入または借方記入にエラーがある場合は、これらのポイント・ブロックを調整する必要があります。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
ExpiryBasisCode: string
タイトル:
Expiry Basis
最大長:30
ポイント・タイプ失効の基準コード。 指定できる値は、ORA_PT_EX_ACC_ACT、ORA_PT_EX_PERIODです。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
ExpiryBasisMeaning: string
読取り専用:
true
ポイント・タイプ失効の基準。 許容される値は、アカウント・アクティビティ(タイプのアクティビティがなく、ポイント・タイプに指定された期間に失効するポイント)、期間(期間の経過後に失効するポイント)、固定日または固定月(ポイントが失効する日および月を指定します)です。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
ExpiryDayCode: string
タイトル:
Expiration Day Code
最大長:30
有効期限日属性は、有効期限基準が日付の場合にポイントの有効期限が切れる日付を指定します。 この属性は失効基準コードに依存します。 この属性に関連付けられたデフォルト値または制限はありません。 -
ExpiryMonthCode: string
タイトル:
Expiration Month Code
最大長:30
失効月属性は、失効基準が月の場合にポイントが失効する月を指定します。 この属性は失効基準コードに依存します。 この属性に関連付けられたデフォルト値または制限はありません。 -
ExpPeriodLen: integer
タイトル:
Period Quantity
失効期間の長さ属性は、ポイントが失効するまでの時間の長さを指定するために使用されます。 たとえば、ポイントが獲得されてから2年後に失効する場合、長さは2に設定されます。 ポイントの有効期限が切れた後、メンバーは報酬と交換できなくなります。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
InternalName: string
タイトル:
Internal Name
最大長:75
ポイント・タイプ属性の内部名。 指定できる値は、Date1またはNumber1です。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date
読取り専用:true
ポイント・タイプ属性が最後に更新された日付。 Oracle Loyalty Cloudは、この属性値を生成し、プロモーション属性が変更されるたびに更新します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
属性を最後に更新したユーザー。 Oracle Loyalty Cloudは、この属性値を生成し、ポイント・タイプ属性が変更されるたびに更新します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
属性を最後に更新したユーザーのログイン詳細。 Oracle Loyalty Cloudは、この属性値を生成し、ポイント・タイプ属性が変更されるたびに更新します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
LoyAttrdefnBId: integer (int64)
タイトル:
Attribute Definition ID
ロイヤルティ属性の主キー。 Oracle Loyalty Cloudは、この属性値を生成します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
MergeActionCode: string
タイトル:
Merge Action
最大長:30
属性マージ処理では、メンバー・マージ中にプログラムが属性を処理する方法を指定します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
MethodName: string
タイトル:
Method Name
最大長:75
昇格昇進基準で使用できるポイント・タイプ属性値の計算に使用されるメソッドです。 たとえば、ORA_CAL_METHOD_MONTH_NAMEメソッドは月の名前を返します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
MinimumReactivationQuantity: number
タイトル:
Minimum Reactivation Quantity
失効ポイントを再アクティブ化して引換に使用できるようにするために必要な最小ポイント。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
MonthsLength: number
タイトル:
Months Length
ポイントが失効する月数に対応する数値。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
ObjectCode: string
タイトル:
Object Code
最大長:30
プロモーションを定義するときに、トランザクション、メンバー、プロモーションなどのエンティティから値を選択するオプション。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
PeriodUOMMeaning: string
読取り専用:
true
ポイント・タイプ期間単位。 期間タイプのオプションは、日、月、四半期、年などです。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
PickApplet: string
タイトル:
Pick Applet
最大長:75
ポイント・タイプのピック・アプレット属性は、ダイアログ・ボックスを使用して値が入力されるフィールドです。 条件およびアクションを定義する場合、このフィールドの値を含むダイアログ・ボックスが表示されます。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
PickField: string
タイトル:
Pick Field
最大長:75
ピック・アプレットから選択した後にユーザーにUIに表示される値のピック・フィールド。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
PickFieldName: string
タイトル:
Pick Field Name
最大長:75
ピック・フィールド名属性は、属性PickFieldのユーザー読取り可能な文字列です。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
PickList: string
タイトル:
Pick List
最大長:75
ピック・リスト属性は、ピック・リストを使用して値が入力されるフィールドである場合に有効になります。 条件およびアクションを定義する場合、このフィールドの値を含むピック・リストが表示されます。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
PointActivityMeaning: string
読取り専用:
true
ポイント・タイプ・アクティビティ・オプションは、見越、引換または見越/引換です。 このフィールドは、ポイント失効基準がアカウント活動である場合にのみアクティブ化されます。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
PrgFormulaId: integer (int64)
タイトル:
Program Formula ID
プロモーションで使用できるが、プロモーションのプログラムと同じプログラムに関連付けられている場合にのみ使用できるプログラムFormula識別子。 算式は、比較の基準、および値を割り当てたり、算式値で属性を更新する処理で使用できます。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
ProgramName: string
読取り専用:
true
ポイント・タイプが作成されるプログラム。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
PromotionId: integer (int64)
タイトル:
Promotion ID
ロイヤルティ・プロモーションの主キー。 Oracle Loyalty Cloudは、この属性値を生成します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
PromotionName: string
読取り専用:
true
promotionId属性に対応するプロモーションの名前。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
QualPointFlag: boolean
タイトル:
Qualifying
最大長:1
デフォルト値:false
ポイント・タイプの資格該当ポイント属性はブール属性であり、プロモーションが適用されるときに発生したポイントが支給階層ステータスにカウントされますが、リ・ワードには利用できません。 デフォルト値はNです。 この属性に関連する依存関係または制限はありません。 -
ReactivateFlag: boolean
タイトル:
Reactivate
最大長:1
デフォルト値:false
再アクティブ化フラグ属性は、失効後にメンバー・ポイントを再アクティブ化します。 デフォルト値はNです。 この属性に関連する依存関係または制限はありません。 -
ReadonlyFlag: boolean
タイトル:
Read Only
最大長:1
デフォルト値:false
ポイント・タイプ属性が編集可能かどうかを指定するブール属性。 デフォルト値はNです。 この属性に関連する依存関係または制限はありません。 -
RetEffFlag: boolean
最大長:
1
デフォルト値:false
ポイント・タイプの有効開始日属性は、属性をプロモーションで使用できる日付を示します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
RptExpPdUOMCode: string
最大長:
30
失効したポイントを再アクティブ化できる期間の単位(UOM)。 許容される値は、年、月、日などです。 たとえば、再有効化の有効期限が1年の場合、単位は年で、失効日から1年後の期間後に失効ポイントを再アクティブ化できます。 この属性に関連付けられたデフォルト値または制限はありません。 -
RptExpPeriodLength: number
失効したポイントを再アクティブ化できる期間。 たとえば、再アクティブ化の有効期限が1年である場合、期間の長さは1で、失効日から1年後の期間後に失効ポイントを再アクティブ化できます。 この属性に関連付けられたデフォルト値または制限はありません。
-
TierClassId: integer (int64)
タイトル:
Tier Class ID
ロイヤルティ階層クラスのプライマリ属性。特定の階層が属するクラスを示します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
TierClassName: string
読取り専用:
true
この属性は、tierClassId属性に対応する層クラスの名前を示します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
WeightFactor: number
タイトル:
Weight Factor
複数のプロモーションが適格な場合、ポイント・タイプ加重係数属性は、トランザクションに適用する必要があるプロモーションを決定するために使用されます。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。 -
WeightFactorNq: number
タイトル:
Weight Factor
加重係数非適格属性は、加重係数属性が指定されている場合に、各タイプの適格ポイントを生成するか非適格ポイントを生成するかを決定するために使用されます。 この属性は、加重係数属性に依存しています。 この属性に関連付けられたデフォルト値または制限はありません。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。