機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

イベントの取得

get

/crmRestApi/resources/11.13.18.05/loyEventsLOV/{LoyEventId}

リクエスト

パス・パラメータ

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

本文( )

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

タイプ: object

ソースを表示

• ActiveFlag: boolean
  タイトル: Active

  最大長: 1

  デフォルト値: false

  作成されたイベントを使用できるようにするかどうかを指定するブール属性。 デフォルト値はNです。 この属性に関連する依存関係または制限はありません。
• CoolOffPeriodInWeeks: number
  タイトル: Cooling off Period in Weeks

  デフォルト値: 0

  ロイヤルティ・プログラムに定義されたイベントのクール・オフ期間。 これは、Oracle Loyalty Cloudがメンバーに対してイベントがすでに作成されているかどうかをチェックする期間です。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  イベントを作成したロイヤルティ・ユーザー。 Oracle Loyalty Cloudは、新しいイベント・レコードの作成時にこの属性値を生成します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。
• CreationDate: string (date-time)
  読取り専用: true

  イベントが作成された日付。 Oracle Loyalty Cloudは、新しいイベント・レコードの作成時にこの属性値を生成します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。
• EventName: string
  タイトル: Event Name

  最大長: 75

  ロイヤルティ・プログラムで定義されたイベント。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。
• IgnoreYearFlag: boolean
  タイトル: Ignore Year

  最大長: 1

  デフォルト値: false

  天候年を指定するブール属性は、イベントの日付からは無視できます。 デフォルト値はNです。 この属性に関連する依存関係または制限はありません。
• LastUpdateDate: string (date-time)
  読取り専用: true

  イベント・レコードが最後に更新された日付。 Oracle Loyalty Cloudは、この属性値を生成し、イベント・レコードの変更が発生するたびに更新します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  イベントを最後に更新したユーザー。 Oracle Loyalty Cloudは、この属性値を生成し、イベントに変更が発生するたびに更新します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  Oracle Loyalty Cloudに最後にログインしたユーザーのログイン詳細。 Oracle Loyalty Cloudは、この属性値を生成し、イベントに変更が発生するたびに更新します。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• LoyEventId: integer (int64)
  プログラムからイベントを一意に識別するためのロイヤルティ・イベント識別子。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。
• MemberAttributeName: string
  タイトル: Member Attribute

  イベントに定義されているメンバー属性の名前。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。
• NegativeOffsetDays: number
  タイトル: Subtracted Days

  デフォルト値: 0

  ロイヤルティ・プログラムに定義されたイベントのマイナスのオフセット日数。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。
• PositiveOffsetDays: number
  タイトル: Added Days

  デフォルト値: 0

  ロイヤルティ・プログラムに定義されたイベントの正のオフセット日数。 この属性に関連付けられたデフォルト値、依存関係または制限はありません。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the event. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the event. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the event is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new event record. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The loyalty user that created the event. Oracle Loyalty Cloud generates this attribute value during the creation of a new event record. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "MemberAttributeName":{
            "title":"Member Attribute",
            "type":"string",
            "description":"The name of the member attribute defined for the event. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LoyEventId":{
            "type":"integer",
            "description":"The loyalty event identifier for uniquely identifying an event from a program. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":75,
            "type":"string",
            "description":"The event defined in the loyalty program. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "NegativeOffsetDays":{
            "title":"Subtracted Days",
            "type":"number",
            "description":"The negative offset days for the event defined for the loyalty program. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "default":0,
            "x-queryable":false
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the created event is enabled for use or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PositiveOffsetDays":{
            "title":"Added Days",
            "type":"number",
            "description":"The positive offset days for the event defined for the loyalty program. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "default":0,
            "x-queryable":false
        },
        "IgnoreYearFlag":{
            "title":"Ignore Year",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies weather year can be ignored from the date for the event. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":false
        },
        "CoolOffPeriodInWeeks":{
            "title":"Cooling off Period in Weeks",
            "type":"number",
            "description":"The cool off period for the event defined for the loyalty program. This is the period for which Oracle Loyalty Cloud checks if an event is already created for the member or not. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "default":0,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last logged in to Oracle Loyalty Cloud. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the events. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the event record was last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the event record occur. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "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."
        }
    }
}

「トップに戻る」