Jump to

• Request
• Response
• Examples

Get a loyalty program

get

/crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}

Request

Path Parameters

• LoyProgramId(required): integer(int64)
  The primary key to identify a program. Oracle Loyalty Cloud generates this attribute value during the creation of a program record. There is no default value, dependency, or limitation associated with this attribute.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : loyPrograms-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the program is available for use or not. The default value is N. There is no dependency or limitation associated with this attribute.
• AllowNegPointFlag: boolean
  Title: Allow Negative Points

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the program is enabled for negative points or not. The default value is N. There is no dependency or limitation associated with this attribute.
• ApplyCode: string
  Title: Apply Code

  Maximum Length: 30

  The attribute value specifies how points are allocated when multiple promotions apply to a transaction. The possible values are Apply All Promos, Maximize by Point Type, and Maximize by Promotion. There is no default value, dependency, or limitation associated with this attribute.
• BatchRedemptionPeriodDuration: number
  Title: Batch Redemption Period Duration

  The batch redemptions that are run periodically to redeem all the outstanding points of all members of a program whose point balance is greater than or equal to the threshold set up under the program, and that reset the point balance of the members to zero. The identifier signifies the period when the batch redemptions run, for example, every month or every number of years. For example, a supermarket chain rewards members for their shopping by giving them points. At the end of the month or any specific period, it converts all the points to dollars and issues vouchers to its members. This process applies only to members whose point balance is greater than or equal to 500 points. There is no default value, dependency, or limitation associated with this attribute.
• BatchRedemptionPeriodTypeCode: string
  Title: Batch Redemption Period Type Code

  Maximum Length: 30

  The program batch redemption period type specifies when a batch redemption runs. For example, if the period type is Years, and the duration is set to 1, then the batch redemption is done once in a year. There is no default value, dependency, or limitation associated with this attribute.
• BUId: integer (int64)
  Title: BU ID

  Default Value: 0

  The business unit identifier provides the details of the organization that runs the program. There is no default value, dependency, or limitation associated with this attribute.
• CalendarAttributes: array Calendar Attributes
  Title: Calendar Attributes

  The calendar attributes resource is used to retrieve the details of the calendar attributes defined for the program.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code used in the loyalty program. The accepted values are INR, USD, and GBP. There is no default value, dependency, or limitation associated with this attribute.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The loyalty user that created the program. Oracle Loyalty Cloud generates this attribute value during the creation of a new program. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Title: Created Date

  Read Only: true

  The date when the program is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new program. There is no default value, dependency, or limitation associated with this attribute.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type used in the loyalty program. There is no default value, dependency, or limitation associated with this attribute.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency used in the loyalty program. The accepted values are INR, USD, and GBP. There is no default value, dependency, or limitation associated with this attribute.
• DeletedFlag: boolean
  Title: Deleted

  Maximum Length: 1

  Default Value: false

  The deleted flag is a boolean attribute that indicates whether the program is marked as deleted or not. Marking a program as deleted does not mean the program is actually deleted from the data base, but instead means the program record is marked as deleted. Once a program is marked as deleted, the program cannot be used by a loyalty user. The default value is N. There is no dependency or limitation associated with this attribute.
• DescriptionText: string
  Title: Program Description

  Maximum Length: 250

  The program description that is provided by the loyalty administrator while creating the program. There is no default value, dependency associated with this attribute.
• EnableEnrollmentBonusFlag: boolean
  Title: Enable Enrollment Bonus

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether a member is awarded any rewards for enrolling into the program. The default value is N. There is no dependency or limitation associated with this attribute.
• EnableReferralBonusFlag: boolean
  Title: Enable Referral Bonus

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether a member is entitled to a reward for a referral. The bonus for referring a new member is provided for the referred member, when the referral bonus flag is enabled. The default value is N. There is no dependency or limitation associated with this attribute.
• EndDate: string (date-time)
  Title: End Date

  The date when the program is no longer in effect for use by members. The end date must be greater than the start date. There is no default value associated with this attribute.
• events: array Events
  Title: Events

  The events resource is used to retrieve the details of the event defined for the loyalty program.
• HostOrgId: integer (int64)
  Title: Host Org ID

  The host organization identifier is the hosting organization that implements the program, for example, Company, Contractors, Partners, and so on. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Title: Change Date

  Read Only: true

  The date when the program is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are any changes to the program. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Title: Changed By

  Read Only: true

  Maximum Length: 64

  The user that last updated the program. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the program. There is no dependency or limitation associated with this attribute.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user that last logged in. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the program. There is no dependency or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyProgramId: integer (int64)
  Title: Loyalty Program ID

  The primary key to identify a program. Oracle Loyalty Cloud generates this attribute value during the creation of a program record. There is no default value, dependency, or limitation associated with this attribute.
• MemberAttributes: array Member Attributes
  Title: Member Attributes

  The member attributes resource is used to retrieve the details of the member attributes defined for the program.
• MemberCount: number
  Title: Member Count

  The member count identifier indicates the total number of members enrolled to the program. There is no default value, dependency, or limitation associated with this attribute.
• MemberFieldAttributes: array Member Field Attributes
  Title: Member Field Attributes

  The member field attributes resource is used to retrieve the details of the member field attributes defined for the program.
• MemberShared: number
  Title: Member Shared

  The member shared attribute previously stored the count of members enrolled into a program through the partners associated with that program. Oracle Loyalty Cloud does not currently use this attribute. There is no default value, dependency, nor limitation associated with this attribute.
• MemberTierAttributes: array Member Tier Attributes
  Title: Member Tier Attributes

  The member tier attributes resource is used to retrieve the details of the member tier attributes defined for the loyalty program.
• Name: string
  Title: Name

  Maximum Length: 50

  The unique identifier that indicates the name of the program. There is no default value, dependency, or limitation associated with this attribute.
• NegativePoints: array Negative Points
  Title: Negative Points

  The negative points resource is used to retrieve the details of negative points defined for the loyalty program.
• PartnerFlag: boolean
  Title: Partner

  Maximum Length: 1

  Default Value: false

  The partner flag is a boolean attribute that differentiates internal programs from partner programs. The default value is N. There is no dependency or limitation associated with this attribute.
• PointBlocks: array Point Blocks
  Title: Point Blocks

  The point blocks resource is used to retrieve the details of the point block defined for the partner.
• PointExpLevelCode: string
  Title: Point Exp Level Code

  Maximum Length: 30

  The point expiration level code, which specifies the level when points expire. The accepted values are Tier Level (expiration of points must be defined for each tier) or Point Type Level (the tier level definition of points expiration is disabled and point expiration can only be defined at the point type level). There is no default value, dependency, or limitation associated with this attribute.
• PointsToPayFlag: boolean
  Title: Point to Pay

  Maximum Length: 1

  Default Value: false

  The boolean flag that allows members to redeem a product despite having an insufficient point balance. For example, consider if redemption prices for a product are either 1000 points or 500 points plus $500. A member having only 600 points can still redeem the product by choosing the second option. This check box is a one-time selection for the program. If this flag is enabled, then the members do not get the points-plus-pay option in any redemption. There is no default value, dependency, or limitation associated with this attribute.
• PointSubtypes: array Point Subtypes
  Title: Point Subtypes

  The point subtypes resource is used to retrieve the details of the loyalty point subtypes defined for the program.
• PointTotalsAttributes: array Point Total Attributes
  Title: Point Total Attributes

  The point total attributes resource is used to retrieve the details of the point totals attributes defined for the program.
• PointTypeId: integer (int64)
  Title: Point Type ID

  The point type identifier uniquely identifies each point type. Various point types are defined to reward and recognize members based on their activities, such as, completing a flight or referring a friend to the program. Some point types are defined to allow members to redeem points for a product or service, while some are defined to track their behavior and reward them by assigning a new tier status. There is no default value, dependency, or limitation associated with this attribute.
• PointTypes: array Point Types
  Title: Point Types

  The point types resource is used to retrieve the details of the loyalty point types defined for the program.
• PrimaryPointTpId: integer (int64)
  Title: Primary Point Type

  The primary key of loyalty point types for the primary point type. Various point types can be defined to reward and recognize members based on their activities, such as completing a flight or referring a friend to the program. Among the defined point types, only one is specified as primary. There is no default value, dependency, or limitation associated with this attribute.
• ProgramNumber: string
  Title: Program Number

  Maximum Length: 30

  The program number for which this point block is created. There is no default value, dependency, or limitation associated with this attribute.
• ProgramOwner: string
  Title: Program Owner

  Maximum Length: 30

  The program owner is the user that created the program and that owns the program. There is no default value, dependency, or limitation associated with this attribute.
• ProgramPartners: array Program Partners
  Title: Program Partners

  The program partners resource is used to retrieve the details of the loyalty partners defined for the program.
• PurchaseStartDayCode: string
  Title: Purchase Start Day Code

  Maximum Length: 30

  The purchase start day code attribute is used to calculate the restrictions on how many points a member can purchase for one year. The one year period starts on the day entered in this field. There is no default value, dependency, or limitation associated with this attribute.
• PurchaseStartMonthCode: string
  Title: Purchase Start Month Code

  Maximum Length: 30

  The purchase start month code attribute is used to calculate restrictions on how many points a member can purchase for one year. The one year period starts from the month entered in this field. There is no default value, dependency, or limitation associated with this attribute.
• RedemptionProducts: array Redemption Products
  Title: Redemption Products

  The redemption products resource is used to retrieve the details of the redemption products defined for the program.
• RevenueRecongnitionPeriodDuration: number
  Title: Revenue Recognition Period Duration

  The revenue recognition period. After a program is in place, results are measured to see if the program is achieving the goals set during the design phase. There is no default value, dependency, or limitation associated with this attribute.
• RevenueRecongnitionPeriodTypeCode: string
  Title: Revenue Recognition Period Type Code

  Maximum Length: 30

  The revenue recognition period type code. The period type is either Months or Years. There is no default value, dependency, or limitation associated with this attribute.
• StartDt: string (date-time)
  Title: Start Date

  The date from when program comes into effect for use by members. The entered date must be less than the end date. There is no default value or dependency.
• ThresholdPointVal: number
  Title: Threshold Point Value

  The threshold point value specifies the minimum points to be attained to qualify for a batch redemption. There is no default value, dependency, or limitation associated with this attribute.
• TierClasses: array Tier Classes
  Title: Tier Classes

  The tier classes resource is used to retrieve the details of a tier class defined for the program.
• TimeZoneCode: string
  Maximum Length: 50

  This attribute indicates timezone code defined for the program. There is no dependency or limitation associated with this attribute.
• TransactionAttributes: array Transaction Attributes
  Title: Transaction Attributes

  The transaction attributes resource is used to retrieve the details of the transaction attributes defined for the program.
• TransactionRestrictions: array Transaction Restrictions
  Title: Transaction Restrictions

  The transaction restrictions resource is used to retrieve the details of the transaction restrictions defined for the loyalty program.
• TransferStartDayCode: string
  Title: Transfer Start Day Code

  Maximum Length: 30

  The transfer start day code attribute is used to calculate restrictions on how many points a member can transfer or give out in a one year period. The one year period starts on the day entered in this field. There is no default value, dependency, or limitation associated with this attribute.
• TransferStartMonthCode: string
  Title: Transfer Start Month Code

  Maximum Length: 30

  The transfer start month code attribute is used to calculate restrictions on how many points a member can transfer or give out in a one year period. The one year period starts on the month entered in this field. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Created Date",
            "type":"string",
            "description":"The date when the program is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new program. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransferStartDayCode":{
            "title":"Transfer Start Day Code",
            "maxLength":30,
            "type":"string",
            "description":"The transfer start day code attribute is used to calculate restrictions on how many points a member can transfer or give out in a one year period. The one year period starts on the day entered in this field. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "EnableEnrollmentBonusFlag":{
            "title":"Enable Enrollment Bonus",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether a member is awarded any rewards for enrolling into the program. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ProgramPartners":{
            "title":"Program Partners",
            "type":"array",
            "description":"The program partners resource is used to retrieve the details of the loyalty partners defined for the program.",
            "items":{
                "$ref":"#/components/schemas/loyPrograms-ProgramPartners-item-response"
            }
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type used in the loyalty program. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "MemberTierAttributes":{
            "title":"Member Tier Attributes",
            "type":"array",
            "description":"The member tier attributes resource is used to retrieve the details of the member tier attributes defined for the loyalty program.",
            "items":{
                "$ref":"#/components/schemas/loyPrograms-MemberTierAttributes-item-response"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier that indicates the name of the program. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "BatchRedemptionPeriodDuration":{
            "title":"Batch Redemption Period Duration",
            "type":"number",
            "description":"The batch redemptions that are run periodically to redeem all the outstanding points of all members of a program whose point balance is greater than or equal to the threshold set up under the program, and that reset the point balance of the members to zero. The identifier signifies the period when the batch redemptions run, for example, every month or every number of years. For example, a supermarket chain rewards members for their shopping by giving them points. At the end of the month or any specific period, it converts all the points to dollars and issues vouchers to its members. This process applies only to members whose point balance is greater than or equal to 500 points. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "TransferStartMonthCode":{
            "title":"Transfer Start Month Code",
            "maxLength":30,
            "type":"string",
            "description":"The transfer start month code attribute is used to calculate restrictions on how many points a member can transfer or give out in a one year period. The one year period starts on the month entered in this field. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency used in the loyalty program. The accepted values are INR, USD, and GBP. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CalendarAttributes":{
            "title":"Calendar Attributes",
            "type":"array",
            "description":"The calendar attributes resource is used to retrieve the details of the calendar attributes defined for the program.",
            "items":{
                "$ref":"#/components/schemas/loyPrograms-CalendarAttributes-item-response"
            }
        },
        "ProgramNumber":{
            "title":"Program Number",
            "maxLength":30,
            "type":"string",
            "description":"The program number for which this point block is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RevenueRecongnitionPeriodDuration":{
            "title":"Revenue Recognition Period Duration",
            "type":"number",
            "description":"The revenue recognition period. After a program is in place, results are measured to see if the program is achieving the goals set during the design phase. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code used in the loyalty program. The accepted values are INR, USD, and GBP. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "events":{
            "title":"Events",
            "type":"array",
            "description":"The events resource is used to retrieve the details of the event defined for the loyalty program.",
            "items":{
                "$ref":"#/components/schemas/loyPrograms-events-item-response"
            }
        },
        "LastUpdatedBy":{
            "title":"Changed By",
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the program. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the program. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PointTotalsAttributes":{
            "title":"Point Total Attributes",
            "type":"array",
            "description":"The point total attributes resource is used to retrieve the details of the point totals attributes defined for the program.",
            "items":{
                "$ref":"#/components/schemas/loyPrograms-PointTotalsAttributes-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The loyalty user that created the program. Oracle Loyalty Cloud generates this attribute value during the creation of a new program. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RevenueRecongnitionPeriodTypeCode":{
            "title":"Revenue Recognition Period Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The revenue recognition period type code. The period type is either Months or Years. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "NegativePoints":{
            "title":"Negative Points",
            "type":"array",
            "description":"The negative points resource is used to retrieve the details of negative points defined for the loyalty program.",
            "items":{
                "$ref":"#/components/schemas/loyPrograms-NegativePoints-item-response"
            }
        },
        "MemberCount":{
            "title":"Member Count",
            "type":"number",
            "description":"The member count identifier indicates the total number of members enrolled to the program. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the program is available 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
        },
        "PointBlocks":{
            "title":"Point Blocks",
            "type":"array",
            "description":"The point blocks resource is used to retrieve the details of the point block defined for the partner.",
            "items":{
                "$ref":"#/components/schemas/loyPrograms-PointBlocks-item-response"
            }
        },
        "PointSubtypes":{
            "title":"Point Subtypes",
            "type":"array",
            "description":"The point subtypes resource is used to retrieve the details of the loyalty point subtypes defined for the program.",
            "items":{
                "$ref":"#/components/schemas/loyPrograms-PointSubtypes-item-response"
            }
        },
        "PointTypeId":{
            "title":"Point Type ID",
            "type":"integer",
            "description":"The point type identifier uniquely identifies each point type. Various point types are defined to reward and recognize members based on their activities, such as, completing a flight or referring a friend to the program. Some point types are defined to allow members to redeem points for a product or service, while some are defined to track their behavior and reward them by assigning a new tier status. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PointsToPayFlag":{
            "title":"Point to Pay",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean flag that allows members to redeem a product despite having an insufficient point balance. For example, consider if redemption prices for a product are either 1000 points or 500 points plus $500. A member having only 600 points can still redeem the product by choosing the second option. This check box is a one-time selection for the program. If this flag is enabled, then the members do not get the points-plus-pay option in any redemption. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "MemberShared":{
            "title":"Member Shared",
            "type":"number",
            "description":"The member shared attribute previously stored the count of members enrolled into a program through the partners associated with that program. Oracle Loyalty Cloud does not currently use this attribute. There is no default value, dependency, nor limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"The deleted flag is a boolean attribute that indicates whether the program is marked as deleted or not. Marking a program as deleted does not mean the program is actually deleted from the data base, but instead means the program record is marked as deleted. Once a program is marked as deleted, the program cannot be used by a loyalty user. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PrimaryPointTpId":{
            "title":"Primary Point Type",
            "type":"integer",
            "description":"The primary key of loyalty point types for the primary point type. Various point types can be defined to reward and recognize members based on their activities, such as completing a flight or referring a friend to the program. Among the defined point types, only one is specified as primary. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionRestrictions":{
            "title":"Transaction Restrictions",
            "type":"array",
            "description":"The transaction restrictions resource is used to retrieve the details of the transaction restrictions defined for the loyalty program.",
            "items":{
                "$ref":"#/components/schemas/loyPrograms-TransactionRestrictions-item-response"
            }
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last logged in. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the program. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionAttributes":{
            "title":"Transaction Attributes",
            "type":"array",
            "description":"The transaction attributes resource is used to retrieve the details of the transaction attributes defined for the program.",
            "items":{
                "$ref":"#/components/schemas/loyPrograms-TransactionAttributes-item-response"
            }
        },
        "MemberAttributes":{
            "title":"Member Attributes",
            "type":"array",
            "description":"The member attributes resource is used to retrieve the details of the member attributes defined for the program.",
            "items":{
                "$ref":"#/components/schemas/loyPrograms-MemberAttributes-item-response"
            }
        },
        "PartnerFlag":{
            "title":"Partner",
            "maxLength":1,
            "type":"boolean",
            "description":"The partner flag is a boolean attribute that differentiates internal programs from partner programs. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PurchaseStartMonthCode":{
            "title":"Purchase Start Month Code",
            "maxLength":30,
            "type":"string",
            "description":"The purchase start month code attribute is used to calculate restrictions on how many points a member can purchase for one year. The one year period starts from the month entered in this field. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "TierClasses":{
            "title":"Tier Classes",
            "type":"array",
            "description":"The tier classes resource is used to retrieve the details of a tier class defined for the program.",
            "items":{
                "$ref":"#/components/schemas/loyPrograms-TierClasses-item-response"
            }
        },
        "BUId":{
            "title":"BU ID",
            "type":"integer",
            "description":"The business unit identifier provides the details of the organization that runs the program. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDt":{
            "title":"Start Date",
            "type":"string",
            "description":"The date from when program comes into effect for use by members. The entered date must be less than the end date. There is no default value or dependency.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RedemptionProducts":{
            "title":"Redemption Products",
            "type":"array",
            "description":"The redemption products resource is used to retrieve the details of the redemption products defined for the program.",
            "items":{
                "$ref":"#/components/schemas/loyPrograms-RedemptionProducts-item-response"
            }
        },
        "EnableReferralBonusFlag":{
            "title":"Enable Referral Bonus",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether a member is entitled to a reward for a referral. The bonus for referring a new member is provided for the referred member, when the referral bonus flag is enabled. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AllowNegPointFlag":{
            "title":"Allow Negative Points",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the program is enabled for negative points or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PointTypes":{
            "title":"Point Types",
            "type":"array",
            "description":"The point types resource is used to retrieve the details of the loyalty point types defined for the program.",
            "items":{
                "$ref":"#/components/schemas/loyPrograms-PointTypes-item-response"
            }
        },
        "ProgramOwner":{
            "title":"Program Owner",
            "maxLength":30,
            "type":"string",
            "description":"The program owner is the user that created the program and that owns the program. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ThresholdPointVal":{
            "title":"Threshold Point Value",
            "type":"number",
            "description":"The threshold point value specifies the minimum points to be attained to qualify for a batch redemption. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplyCode":{
            "title":"Apply Code",
            "maxLength":30,
            "type":"string",
            "description":"The attribute value specifies how points are allocated when multiple promotions apply to a transaction. The possible values are Apply All Promos, Maximize by Point Type, and Maximize by Promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PointExpLevelCode":{
            "title":"Point Exp Level Code",
            "maxLength":30,
            "type":"string",
            "description":"The point expiration level code, which specifies the level when points expire. The accepted values are Tier Level (expiration of points must be defined for each tier) or Point Type Level (the tier level definition of points expiration is disabled and point expiration can only be defined at the point type level). There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the program is no longer in effect for use by members. The end date must be greater than the start date. There is no default value associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PurchaseStartDayCode":{
            "title":"Purchase Start Day Code",
            "maxLength":30,
            "type":"string",
            "description":"The purchase start day code attribute is used to calculate the restrictions on how many points a member can purchase for one year. The one year period starts on the day entered in this field. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "BatchRedemptionPeriodTypeCode":{
            "title":"Batch Redemption Period Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The program batch redemption period type specifies when a batch redemption runs. For example, if the period type is Years, and the duration is set to 1, then the batch redemption is done once in a year. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "HostOrgId":{
            "title":"Host Org ID",
            "type":"integer",
            "description":"The host organization identifier is the hosting organization that implements the program, for example, Company, Contractors, Partners, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TimeZoneCode":{
            "maxLength":50,
            "type":"string",
            "description":"This attribute indicates timezone code defined for the program. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LoyProgramId":{
            "title":"Loyalty Program ID",
            "type":"integer",
            "description":"The primary key to identify a program. Oracle Loyalty Cloud generates this attribute value during the creation of a program record. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DescriptionText":{
            "title":"Program Description",
            "maxLength":250,
            "type":"string",
            "description":"The program description that is provided by the loyalty administrator while creating the program. There is no default value, dependency associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Change Date",
            "type":"string",
            "description":"The date when the program is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are any changes to the program. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberFieldAttributes":{
            "title":"Member Field Attributes",
            "type":"array",
            "description":"The member field attributes resource is used to retrieve the details of the member field attributes defined for the program.",
            "items":{
                "$ref":"#/components/schemas/loyPrograms-MemberFieldAttributes-item-response"
            }
        }
    }
}

Nested Schema : Calendar Attributes

Type: array

Title: Calendar Attributes

The calendar attributes resource is used to retrieve the details of the calendar attributes defined for the program.

Show Source

• Array of: object loyPrograms-CalendarAttributes-item-response

{
    "title":"Calendar Attributes",
    "type":"array",
    "description":"The calendar attributes resource is used to retrieve the details of the calendar attributes defined for the program.",
    "items":{
        "$ref":"#/components/schemas/loyPrograms-CalendarAttributes-item-response"
    }
}

Nested Schema : Events

Type: array

Title: Events

The events resource is used to retrieve the details of the event defined for the loyalty program.

Show Source

• Array of: object loyPrograms-events-item-response

{
    "title":"Events",
    "type":"array",
    "description":"The events resource is used to retrieve the details of the event defined for the loyalty program.",
    "items":{
        "$ref":"#/components/schemas/loyPrograms-events-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Member Attributes

Type: array

Title: Member Attributes

The member attributes resource is used to retrieve the details of the member attributes defined for the program.

Show Source

• Array of: object loyPrograms-MemberAttributes-item-response

{
    "title":"Member Attributes",
    "type":"array",
    "description":"The member attributes resource is used to retrieve the details of the member attributes defined for the program.",
    "items":{
        "$ref":"#/components/schemas/loyPrograms-MemberAttributes-item-response"
    }
}

Nested Schema : Member Field Attributes

Type: array

Title: Member Field Attributes

The member field attributes resource is used to retrieve the details of the member field attributes defined for the program.

Show Source

• Array of: object loyPrograms-MemberFieldAttributes-item-response

{
    "title":"Member Field Attributes",
    "type":"array",
    "description":"The member field attributes resource is used to retrieve the details of the member field attributes defined for the program.",
    "items":{
        "$ref":"#/components/schemas/loyPrograms-MemberFieldAttributes-item-response"
    }
}

Nested Schema : Member Tier Attributes

Type: array

Title: Member Tier Attributes

The member tier attributes resource is used to retrieve the details of the member tier attributes defined for the loyalty program.

Show Source

• Array of: object loyPrograms-MemberTierAttributes-item-response

{
    "title":"Member Tier Attributes",
    "type":"array",
    "description":"The member tier attributes resource is used to retrieve the details of the member tier attributes defined for the loyalty program.",
    "items":{
        "$ref":"#/components/schemas/loyPrograms-MemberTierAttributes-item-response"
    }
}

Nested Schema : Negative Points

Type: array

Title: Negative Points

The negative points resource is used to retrieve the details of negative points defined for the loyalty program.

Show Source

• Array of: object loyPrograms-NegativePoints-item-response

{
    "title":"Negative Points",
    "type":"array",
    "description":"The negative points resource is used to retrieve the details of negative points defined for the loyalty program.",
    "items":{
        "$ref":"#/components/schemas/loyPrograms-NegativePoints-item-response"
    }
}

Nested Schema : Point Blocks

Type: array

Title: Point Blocks

The point blocks resource is used to retrieve the details of the point block defined for the partner.

Show Source

• Array of: object loyPrograms-PointBlocks-item-response

{
    "title":"Point Blocks",
    "type":"array",
    "description":"The point blocks resource is used to retrieve the details of the point block defined for the partner.",
    "items":{
        "$ref":"#/components/schemas/loyPrograms-PointBlocks-item-response"
    }
}

Nested Schema : Point Subtypes

Type: array

Title: Point Subtypes

The point subtypes resource is used to retrieve the details of the loyalty point subtypes defined for the program.

Show Source

• Array of: object loyPrograms-PointSubtypes-item-response

{
    "title":"Point Subtypes",
    "type":"array",
    "description":"The point subtypes resource is used to retrieve the details of the loyalty point subtypes defined for the program.",
    "items":{
        "$ref":"#/components/schemas/loyPrograms-PointSubtypes-item-response"
    }
}

Nested Schema : Point Total Attributes

Type: array

Title: Point Total Attributes

The point total attributes resource is used to retrieve the details of the point totals attributes defined for the program.

Show Source

• Array of: object loyPrograms-PointTotalsAttributes-item-response

{
    "title":"Point Total Attributes",
    "type":"array",
    "description":"The point total attributes resource is used to retrieve the details of the point totals attributes defined for the program.",
    "items":{
        "$ref":"#/components/schemas/loyPrograms-PointTotalsAttributes-item-response"
    }
}

Nested Schema : Point Types

Type: array

Title: Point Types

The point types resource is used to retrieve the details of the loyalty point types defined for the program.

Show Source

• Array of: object loyPrograms-PointTypes-item-response

{
    "title":"Point Types",
    "type":"array",
    "description":"The point types resource is used to retrieve the details of the loyalty point types defined for the program.",
    "items":{
        "$ref":"#/components/schemas/loyPrograms-PointTypes-item-response"
    }
}

Nested Schema : Program Partners

Type: array

Title: Program Partners

The program partners resource is used to retrieve the details of the loyalty partners defined for the program.

Show Source

• Array of: object loyPrograms-ProgramPartners-item-response

{
    "title":"Program Partners",
    "type":"array",
    "description":"The program partners resource is used to retrieve the details of the loyalty partners defined for the program.",
    "items":{
        "$ref":"#/components/schemas/loyPrograms-ProgramPartners-item-response"
    }
}

Nested Schema : Redemption Products

Type: array

Title: Redemption Products

The redemption products resource is used to retrieve the details of the redemption products defined for the program.

Show Source

• Array of: object loyPrograms-RedemptionProducts-item-response

{
    "title":"Redemption Products",
    "type":"array",
    "description":"The redemption products resource is used to retrieve the details of the redemption products defined for the program.",
    "items":{
        "$ref":"#/components/schemas/loyPrograms-RedemptionProducts-item-response"
    }
}

Nested Schema : Tier Classes

Type: array

Title: Tier Classes

The tier classes resource is used to retrieve the details of a tier class defined for the program.

Show Source

• Array of: object loyPrograms-TierClasses-item-response

{
    "title":"Tier Classes",
    "type":"array",
    "description":"The tier classes resource is used to retrieve the details of a tier class defined for the program.",
    "items":{
        "$ref":"#/components/schemas/loyPrograms-TierClasses-item-response"
    }
}

Nested Schema : Transaction Attributes

Type: array

Title: Transaction Attributes

The transaction attributes resource is used to retrieve the details of the transaction attributes defined for the program.

Show Source

• Array of: object loyPrograms-TransactionAttributes-item-response

{
    "title":"Transaction Attributes",
    "type":"array",
    "description":"The transaction attributes resource is used to retrieve the details of the transaction attributes defined for the program.",
    "items":{
        "$ref":"#/components/schemas/loyPrograms-TransactionAttributes-item-response"
    }
}

Nested Schema : Transaction Restrictions

Type: array

Title: Transaction Restrictions

The transaction restrictions resource is used to retrieve the details of the transaction restrictions defined for the loyalty program.

Show Source

• Array of: object loyPrograms-TransactionRestrictions-item-response

{
    "title":"Transaction Restrictions",
    "type":"array",
    "description":"The transaction restrictions resource is used to retrieve the details of the transaction restrictions defined for the loyalty program.",
    "items":{
        "$ref":"#/components/schemas/loyPrograms-TransactionRestrictions-item-response"
    }
}

Nested Schema : loyPrograms-CalendarAttributes-item-response

Type: object

Show Source

• AccountActionCode: string
  Title: Account Activity

  Maximum Length: 30

  The calendar attribute account activity option. If specified, then the points expire if there is no activity of the type within the period specified for the point type. There is no default value, dependency, or limitation associated with this attribute.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  The attribute active flag is a boolean attribute that specifies whether the created calendar attribute is enabled for the user or not. The default value is N. There is no dependency or limitation associated with this attribute.
• AttrDefnId: integer (int64)
  Title: Attribute Definition ID

  The primary key value of the loyalty attribute definitions corresponding to attribute types like pointType, Member, Transaction, and so on. There is no default value, dependency, or limitation associated with this attribute.
• AttrTypeCode: string
  Title: Attribute Type Code

  Maximum Length: 30

  Default Value: Field

  The identifier reflects the type of attribute, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.
• BusSvcName: string
  Title: Field

  Maximum Length: 75

  The external business service that can be called in a promotion for the evaluation of business criteria. There is no default value, dependency, or limitation associated with this attribute.
• CancelActnCode: string
  Title: Cancel Action Code

  Maximum Length: 30

  The specification of which action must be applied during a transaction cancellation. The accepted values are Leave As Is (if selected, the value of the attribute remains the same when a transaction is cancelled), Revert, and so on. There is no default value, dependency, or limitation associated with this attribute.
• CostPERPoint: number
  The cost for each point. If you want to allow the product to be redeemed for a combination of points and currency, then enter the amount as the cash value for one point. There is no default value, dependency, or limitation associated with this attribute.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user that created the calendar attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a calendar attribute. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the calendar attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a loyalty attribute. There is no default value, dependency, or limitation associated with this attribute.
• CurrencyCode: integer (int64)
  Title: Currency

  The currency used in the transaction. The accepted values are INR, USD, GBP, and so on. There is no default value, dependency, or limitation associated with this attribute.
• CurrencyExchDt: string (date)
  Title: Currency Exchange Date

  The date when the calendar attribute currency exchange takes place. This attribute displays the date of the currency exchange during the calendar attribute creation. There is no default value, dependency, or limitation associated with this attribute.
• DataType: string
  Title: Data Type Meaning

  Read Only: true

  Maximum Length: 80

  The calendar attribute data type indicates whether the attribute is a string, or a number, and so on. During a transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value or limitation associated with this attribute.
• DataTypeCode: string
  Title: Data Type

  Maximum Length: 30

  The calendar attribute data type code indicates whether the attribute is a string, or a number, and so on. During a transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value or limitation associated with this attribute.
• DefaultValue: string
  Title: Default Value

  Maximum Length: 75

  The default value that is used when the attribute is created for a member for the first time. There is no default value, dependency, or limitation associated with this attribute.
• DescriptionText: string
  Title: Description

  Maximum Length: 1000

  The additional information pertaining to the calendar attribute. There is no default value, dependency, or limitation associated with this attribute.
• DisplayFlag: boolean
  Title: Display

  Maximum Length: 1

  Default Value: true

  The boolean attribute that indicates whether the calendar attribute should be displayed or not, so that it can be used in the promotion criteria. The default value is Y. There is no dependency or limitation associated with this attribute.
• DisplayName: string
  Title: Name

  Maximum Length: 30

  The calendar attribute display name that is visible to the user. There is no default value, dependency, or limitation associated with this attribute.
• DynamicFlag: boolean
  Title: Dynamic

  Maximum Length: 1

  Default Value: false

  The boolean attribute that indicates whether the calendar attribute value is calculated dynamically based on another attribute, and which is used in the promotion criteria. The criteria can compare an attribute to a value or compare an attribute to another attribute. The default value is N. There is no dependency or limitation associated with this attribute.
• ExpiryAlignCode: string
  Title: Expiration Aligned

  Maximum Length: 30

  The expiry alignment attribute provides the details pertaining to the calculation of the expiry of points. There is no default value, dependency, or limitation associated with this attribute.
• ExpiryBasisCode: string
  Title: Expiration Basis

  Maximum Length: 30

  The basis for the point or voucher expiry. The accepted values are Period (expires after a period of time) or Date (expires on a specific date). There is no default value, dependency, or limitation associated with this attribute.
• ExpiryDayCode: string
  Title: Expiration Day Code

  Maximum Length: 30

  The calendar attribute expiry day specifies the day of the month when the points expire if the expiry basis is set to Date. The attribute is dependent on the Expiry Basis Code attribute. There is no default value or limitation associated with this attribute.
• ExpiryMonthCode: string
  Title: Expiration Month Code

  Maximum Length: 30

  The calendar attribute expiry month specifies the month when the points expire if the expiry basis is set to Month. The attribute is dependent on Expiry Basis Code. There is no default value or limitation associated with this attribute.
• ExpPdUOMCode: string
  Title: Expiration Period Unit of Measure

  Maximum Length: 30

  The expiry period unit of measure (UOM) is used to specify when points expire. For example, if the points expire a year after they are earned, UOM is set to Year. After the points expire, the member can no longer exchange points for rewards. There is no default value, dependency, or limitation associated with this attribute.
• ExpPeriodLength: integer
  Title: Expiration Period Length

  The attribute expiry period length is used to specify a length of time after when points expire. For example, if the points expire two years after they are earned, then the length is set to 2. After the points expire, the member can no longer exchange them for rewards. There is no default value, dependency, or limitation associated with this attribute.
• InternalName: string
  Title: Internal Name

  Maximum Length: 75

  The internal name of the calendar attribute. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the attribute is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are any changes to the attribute value. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes to the attribute take place. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user that last logged in. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes to the attribute occur. There is no default value, dependency, or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyAttrdefnBId: integer (int64)
  Title: Attribute Definition ID

  The primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• MergeActionCode: string
  Title: Merge Action

  Maximum Length: 30

  The attribute merge action that specifies how the program handles the attribute during a member merge. There is no default value, dependency, or limitation associated with this attribute.
• Method: string
  Title: Method Meaning

  Read Only: true

  Maximum Length: 80

  The method that is used in the calculation of the calendar attribute value that can be used in promotion criteria. For example, the ORA_CAL_METHOD_MONTH_NAME method returns the month name. There is no default value, dependency, or limitation associated with this attribute.
• MethodName: string
  Title: Method

  Maximum Length: 75

  The method that is used in calculations of the program attribute value that can be used in promotion criteria. For example, the ORA_CAL_METHOD_MONTH_NAME method gives the month name. There is no default value, dependency, or limitation associated with this attribute.
• MinimumReactivationQuantity: number
  Title: Minimum Reactivation Quantity

  The minimum points needed to reactivate the expired points, so that they can be used for redemption. There is no default value, dependency, or limitation associated with this attribute.
• MonthsLength: number
  Title: Months Length

  The numeric value that corresponds to the number of months during which points will expire. There is no default value, dependency, or limitation associated with this attribute.
• ObjectCode: string
  Title: Object Code

  Maximum Length: 30

  Default Value: Calendar

  The option to select values from entities such as Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.
• PickApplet: string
  Title: Pick Applet

  Maximum Length: 75

  The pick applet attribute is a field whose values are entered using a dialog box. While defining criteria and actions, the dialog box with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.
• PickField: string
  Title: Pick Field

  Maximum Length: 75

  The pick field whose value the user sees in the UI after selecting the value from the pick applet. There is no default value, dependency, or limitation associated with this attribute.
• PickFieldName: string
  Title: Pick Field Name

  Maximum Length: 75

  The attribute pick field name is the user readable string of the PickField attribute. There is no default value, dependency, or limitation associated with this attribute.
• PickList: string
  Title: Pick List

  Maximum Length: 75

  The pick list that is enabled if the attribute is a field whose values are entered using a picklist. When defining criteria and actions, the picklist is displayed with the values for this field . There is no default value, dependency, or limitation associated with this attribute.
• ProgramName: string
  Read Only: true

  The program for which calendar attribute is created. There is no default value, dependency, or limitation associated with this attribute.
• PromotionId: integer (int64)
  Title: Promotion ID

  The primary key of loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• PromotionName: string
  Read Only: true

  The name of the loyalty promotion corresponding to the promotionId attribute. There is no default value, dependency, or limitation associated with this attribute.
• QualPointFlag: boolean
  Title: Qualifying Point

  Maximum Length: 1

  Default Value: false

  The promotion attribute qualifying point is a boolean attribute that indicates that the points accrued when the promotion gets applied count toward earning tier status, but cannot be redeemed for rewards. The default value is N. There is no dependency or limitation associated with this attribute.
• ReactivateFlag: boolean
  Title: Reactivate

  Maximum Length: 1

  Default Value: false

  The reactivate flag attribute reactivates members points after they have expired. The default value is N. There is no dependency or limitation associated with this attribute.
• ReadonlyFlag: boolean
  Title: Read Only

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the promotion attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.
• RetEffFlag: boolean
  Maximum Length: 1

  Default Value: false

  The attribute effective start date indicates the date when the attribute can be used in promotions. There is no default value, dependency, or limitation associated with this attribute.
• RptExpPdUOMCode: string
  Maximum Length: 30

  The unit of measure (UOM) for the time period until the expired points can be reactivated. The accepted values are Years, Months, Days, and so on. For example, if the reactivation expiry period is one year, then the unit of measure (UOM) is Year and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.
• RptExpPeriodLength: number
  The time period when the expired points can be reactivated. For example, if the reactivation expiry period is one year, then the time period length is 1 and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.
• TierClassId: integer (int64)
  Title: Tier Class ID

  The primary attribute of the loyalty tier class that indicates the class to which a specific tier belongs. There is no default value, dependency, or limitation associated with this attribute.
• TierClassName: string
  Read Only: true

  The attribute that indicates the name of the tier class corresponding to tierClassId attribute. There is no default value, dependency, or limitation associated with this attribute.
• WeightFactor: number
  Title: Weight Factor

  The attribute weight factor is used to determine which promotion applies to the transaction, if multiple promotions qualify. There is no default value, dependency, or limitation associated with this attribute.
• WeightFactorNq: number
  Title: Weight Factor

  The attribute weight factor non-qualifying attribute is used to determine whether to generate qualifying or non-qualifying points of each type when the weight factor attribute is specified. This attribute has a dependency on the Weight Factor attribute. There is no default value or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "WeightFactor":{
            "title":"Weight Factor",
            "type":"number",
            "description":"The attribute weight factor is used to determine which promotion applies to the transaction, if multiple promotions qualify. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the calendar attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a loyalty attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionId":{
            "title":"Promotion ID",
            "type":"integer",
            "description":"The primary key of loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttrTypeCode":{
            "title":"Attribute Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The identifier reflects the type of attribute, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":"Field",
            "x-queryable":true
        },
        "AttrDefnId":{
            "title":"Attribute Definition ID",
            "type":"integer",
            "description":"The primary key value of the loyalty attribute definitions corresponding to attribute types like pointType, Member, Transaction, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InternalName":{
            "title":"Internal Name",
            "maxLength":75,
            "type":"string",
            "description":"The internal name of the calendar attribute. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":30,
            "type":"string",
            "description":"The option to select values from entities such as Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":"Calendar",
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "type":"integer",
            "description":"The currency used in the transaction. The accepted values are INR, USD, GBP, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PromotionName":{
            "type":"string",
            "description":"The name of the loyalty promotion corresponding to the promotionId attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RptExpPeriodLength":{
            "type":"number",
            "description":"The time period when the expired points can be reactivated. For example, if the reactivation expiry period is one year, then the time period length is 1 and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "QualPointFlag":{
            "title":"Qualifying Point",
            "maxLength":1,
            "type":"boolean",
            "description":"The promotion attribute qualifying point is a boolean attribute that indicates that the points accrued when the promotion gets applied count toward earning tier status, but cannot be redeemed for rewards. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MethodName":{
            "title":"Method",
            "maxLength":75,
            "type":"string",
            "description":"The method that is used in calculations of the program attribute value that can be used in promotion criteria. For example, the ORA_CAL_METHOD_MONTH_NAME method gives the month name. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostPERPoint":{
            "type":"number",
            "description":"The cost for each point. If you want to allow the product to be redeemed for a combination of points and currency, then enter the amount as the cash value for one point. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes to the attribute take place. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountActionCode":{
            "title":"Account Activity",
            "maxLength":30,
            "type":"string",
            "description":"The calendar attribute account activity option. If specified, then the points expire if there is no activity of the type within the period specified for the point type. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user that created the calendar attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a calendar attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpPdUOMCode":{
            "title":"Expiration Period Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"The expiry period unit of measure (UOM) is used to specify when points expire. For example, if the points expire a year after they are earned, UOM is set to Year. After the points expire, the member can no longer exchange points for rewards. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyExchDt":{
            "title":"Currency Exchange Date",
            "type":"string",
            "description":"The date when the calendar attribute currency exchange takes place. This attribute displays the date of the currency exchange during the calendar attribute creation. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"Method Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The method that is used in the calculation of the calendar attribute value that can be used in promotion criteria. For example, the ORA_CAL_METHOD_MONTH_NAME method returns the month name. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "ProgramName":{
            "type":"string",
            "description":"The program for which calendar attribute is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"The attribute active flag is a boolean attribute that specifies whether the created calendar attribute is enabled for the user or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ReactivateFlag":{
            "title":"Reactivate",
            "maxLength":1,
            "type":"boolean",
            "description":"The reactivate flag attribute reactivates members points after they have expired. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PickFieldName":{
            "title":"Pick Field Name",
            "maxLength":75,
            "type":"string",
            "description":"The attribute pick field name is the user readable string of the PickField attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpiryMonthCode":{
            "title":"Expiration Month Code",
            "maxLength":30,
            "type":"string",
            "description":"The calendar attribute expiry month specifies the month when the points expire if the expiry basis is set to Month. The attribute is dependent on Expiry Basis Code. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "WeightFactorNq":{
            "title":"Weight Factor",
            "type":"number",
            "description":"The attribute weight factor non-qualifying attribute is used to determine whether to generate qualifying or non-qualifying points of each type when the weight factor attribute is specified. This attribute has a dependency on the Weight Factor attribute. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ReadonlyFlag":{
            "title":"Read Only",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the promotion attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PickList":{
            "title":"Pick List",
            "maxLength":75,
            "type":"string",
            "description":"The pick list that is enabled if the attribute is a field whose values are entered using a picklist. When defining criteria and actions, the picklist is displayed with the values for this field . There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayFlag":{
            "title":"Display",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that indicates whether the calendar attribute should be displayed or not, so that it can be used in the promotion criteria. The default value is Y. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "DataTypeCode":{
            "title":"Data Type",
            "maxLength":30,
            "type":"string",
            "description":"The calendar attribute data type code indicates whether the attribute is a string, or a number, and so on. During a transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "RptExpPdUOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure (UOM) for the time period until the expired points can be reactivated. The accepted values are Years, Months, Days, and so on. For example, if the reactivation expiry period is one year, then the unit of measure (UOM) is Year and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last logged in. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes to the attribute occur. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CancelActnCode":{
            "title":"Cancel Action Code",
            "maxLength":30,
            "type":"string",
            "description":"The specification of which action must be applied during a transaction cancellation. The accepted values are Leave As Is (if selected, the value of the attribute remains the same when a transaction is cancelled), Revert, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "MergeActionCode":{
            "title":"Merge Action",
            "maxLength":30,
            "type":"string",
            "description":"The attribute merge action that specifies how the program handles the attribute during a member merge. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PickField":{
            "title":"Pick Field",
            "maxLength":75,
            "type":"string",
            "description":"The pick field whose value the user sees in the UI after selecting the value from the pick applet. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultValue":{
            "title":"Default Value",
            "maxLength":75,
            "type":"string",
            "description":"The default value that is used when the attribute is created for a member for the first time. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpPeriodLength":{
            "title":"Expiration Period Length",
            "type":"integer",
            "description":"The attribute expiry period length is used to specify a length of time after when points expire. For example, if the points expire two years after they are earned, then the length is set to 2. After the points expire, the member can no longer exchange them for rewards. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumReactivationQuantity":{
            "title":"Minimum Reactivation Quantity",
            "type":"number",
            "description":"The minimum points needed to reactivate the expired points, so that they can be used for redemption. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DynamicFlag":{
            "title":"Dynamic",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that indicates whether the calendar attribute value is calculated dynamically based on another attribute, and which is used in the promotion criteria. The criteria can compare an attribute to a value or compare an attribute to another attribute. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The calendar attribute display name that is visible to the user. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "TierClassId":{
            "title":"Tier Class ID",
            "type":"integer",
            "description":"The primary attribute of the loyalty tier class that indicates the class to which a specific tier belongs. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DataType":{
            "title":"Data Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The calendar attribute data type indicates whether the attribute is a string, or a number, and so on. During a transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "RetEffFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The attribute effective start date indicates the date when the attribute can be used in promotions. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "MonthsLength":{
            "title":"Months Length",
            "type":"number",
            "description":"The numeric value that corresponds to the number of months during which points will expire. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "TierClassName":{
            "type":"string",
            "description":"The attribute that indicates the name of the tier class corresponding to tierClassId attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpiryBasisCode":{
            "title":"Expiration Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis for the point or voucher expiry. The accepted values are Period (expires after a period of time) or Date (expires on a specific date). There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PickApplet":{
            "title":"Pick Applet",
            "maxLength":75,
            "type":"string",
            "description":"The pick applet attribute is a field whose values are entered using a dialog box. While defining criteria and actions, the dialog box with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpiryAlignCode":{
            "title":"Expiration Aligned",
            "maxLength":30,
            "type":"string",
            "description":"The expiry alignment attribute provides the details pertaining to the calculation of the expiry of points. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpiryDayCode":{
            "title":"Expiration Day Code",
            "maxLength":30,
            "type":"string",
            "description":"The calendar attribute expiry day specifies the day of the month when the points expire if the expiry basis is set to Date. The attribute is dependent on the Expiry Basis Code attribute. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LoyAttrdefnBId":{
            "title":"Attribute Definition ID",
            "type":"integer",
            "description":"The primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The additional information pertaining to the calendar attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "BusSvcName":{
            "title":"Field",
            "maxLength":75,
            "type":"string",
            "description":"The external business service that can be called in a promotion for the evaluation of business criteria. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the attribute is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are any changes to the attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: 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."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : loyPrograms-events-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  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.
• CoolOffPeriodInWeeks: number
  Title: Cooling off Period in Weeks

  Default Value: 0

  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.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  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.
• CreationDate: string (date-time)
  Read Only: true

  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.
• EventName: string
  Title: Event Name

  Maximum Length: 75

  The event defined in the loyalty program. There is no default value, dependency, or limitation associated with this attribute.
• eventTransactionAttributes: array Event Transaction Attributes
  Title: Event Transaction Attributes

  The event transaction attributes resource is used to retrieve the details of the event terms defined for the event.
• IgnoreYearFlag: boolean
  Title: Ignore Year

  Maximum Length: 1

  Default Value: false

  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.
• LastUpdateDate: string (date-time)
  Read Only: true

  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.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  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.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyEventId: integer (int64)
  The loyalty event identifier for uniquely identifying an event from a program. There is no default value, dependency, or limitation associated with this attribute.
• MemberAttributeName: string
  Title: Member Attribute

  The name of the member attribute defined for the event. There is no default value, dependency, or limitation associated with this attribute.
• NegativeOffsetDays: number
  Title: Subtracted Days

  Default Value: 0

  The negative offset days for the event defined for the loyalty program. There is no default value, dependency, or limitation associated with this attribute.
• PositiveOffsetDays: number
  Title: Added Days

  Default Value: 0

  The positive offset days for the event defined for the loyalty program. There is no default value, dependency, or limitation associated with this attribute.

{
    "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"
            }
        },
        "eventTransactionAttributes":{
            "title":"Event Transaction Attributes",
            "type":"array",
            "description":"The event transaction attributes resource is used to retrieve the details of the event terms defined for the event.",
            "items":{
                "$ref":"#/components/schemas/loyPrograms-events-eventTransactionAttributes-item-response"
            }
        },
        "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
        }
    }
}

Nested Schema : Event Transaction Attributes

Type: array

Title: Event Transaction Attributes

The event transaction attributes resource is used to retrieve the details of the event terms defined for the event.

Show Source

• Array of: object loyPrograms-events-eventTransactionAttributes-item-response

{
    "title":"Event Transaction Attributes",
    "type":"array",
    "description":"The event transaction attributes resource is used to retrieve the details of the event terms defined for the event.",
    "items":{
        "$ref":"#/components/schemas/loyPrograms-events-eventTransactionAttributes-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : loyPrograms-events-eventTransactionAttributes-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The loyalty user that created the event transaction attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new event transaction attribute record. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Read Only: true

  The date when the event transaction attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new event transaction attribute record. There is no default value, dependency, or limitation associated with this attribute.
• EventAttrId: integer (int64)
  The event attribute identifier. There is no default value, dependency, or limitation associated with this attribute.
• InvOrgId: integer (int64)
  The organization from where inventory is being picked. For example, when a transaction is created, the inventory or goods might be picked from the partner and directly delivered to the customer. That is, the transaction is created for one organization, but the inventory is picked from a different organization. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the event transaction attribute record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the event transaction attribute record occur. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that last updated the event transaction attribute. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the event transaction attribute. There is no dependency or limitation associated with this attribute.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The user that last updated the event transaction attribute. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the event transaction attribute. There is no dependency or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberAttrName: string
  Title: Member Attribute

  The name of the member attribute defined for the event transaction. There is no default value, dependency, or limitation associated with this attribute.
• ProdId: integer (int64)
  The loyalty product identifier. This attribute describes the product that is going to be used in the event transaction that has been created.There is no default value, dependency, or limitation associated with this attribute.
• ProductNumber: string
  The loyalty product number. This attribute describes the product that is going to be used in the event transaction that has been created.There is no default value, dependency, or limitation associated with this attribute.
• TransactionAttrName: string
  Title: Attribute

  The transaction attribute name of the event transaction attribute defined for the event. There is no default value, dependency, or limitation associated with this attribute.
• TransactionAttrValue: string
  Title: Fixed Value

  Maximum Length: 75

  The transaction attribute value of the event transaction attribute defined for the event. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the event transaction attribute. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the event transaction attribute. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the event transaction attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new event transaction attribute 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 transaction attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new event transaction attribute record. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The organization from where inventory is being picked. For example, when a transaction is created, the inventory or goods might be picked from the partner and directly delivered to the customer. That is, the transaction is created for one organization, but the inventory is picked from a different organization. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductNumber":{
            "type":"string",
            "description":"The loyalty product number. This attribute describes the product that is going to be used in the event transaction that has been created.There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionAttrValue":{
            "title":"Fixed Value",
            "maxLength":75,
            "type":"string",
            "description":"The transaction attribute value of the event transaction attribute defined for the event. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProdId":{
            "type":"integer",
            "description":"The loyalty product identifier. This attribute describes the product that is going to be used in the event transaction that has been created.There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionAttrName":{
            "title":"Attribute",
            "type":"string",
            "description":"The transaction attribute name of the event transaction 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"
            }
        },
        "EventAttrId":{
            "type":"integer",
            "description":"The event attribute identifier. 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"
            }
        },
        "MemberAttrName":{
            "title":"Member Attribute",
            "type":"string",
            "description":"The name of the member attribute defined for the event transaction. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the event transaction attribute record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the event transaction attribute record occur. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The user that last updated the event transaction attribute. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the event transaction attribute. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : loyPrograms-MemberAttributes-item-response

Type: object

Show Source

• AccntActCode: string
  Title: Account Activity

  Maximum Length: 30

  The member attribute account activity code. If this option is specified, then points expire if there is no activity of the type within the period specified for the point type. There is no default value, dependency, or limitation associated with this attribute.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the created member attribute is enabled for use or not. The default value is N. There is no dependency or limitation associated with this attribute.
• AttrDefnId: integer (int64)
  Title: Attribute Definition ID

  The primary key value of the loyalty attribute definitions corresponding to attribute types like pointType, Member, Transaction, and so on. There is no default value, dependency, or limitation associated with this attribute.
• AttrTypeCode: string
  Title: Attribute Type Code

  Maximum Length: 30

  Default Value: Child Attribute

  The promotion attribute type code. This attribute reflects the attribute type, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.
• BusSvcName: string
  Title: Business Service Name

  Maximum Length: 75

  The external business service that can be called in the promotion to evaluate business criteria. There is no default value, dependency, or limitation associated with this attribute.
• CancelActn: string
  Title: Cancel Action Meaning

  Read Only: true

  Maximum Length: 80

  The specification of which action must be applied during a transaction cancellation. The accepted values are Leave As Is (if selected, the value of the attribute remains the same when a transaction is cancelled), Revert, and so on. There is no default value, dependency, or limitation associated with this attribute.
• CancelActnCode: string
  Title: Cancel Action

  Maximum Length: 30

  The specification of the action which must be applied during a transaction cancellation. The accepted values are Leave As Is (if selected, the value of the attribute remains the same when a transaction is cancelled), Revert, and so on. There is no default value, dependency, or limitation associated with this attribute.
• CostperPoint: number
  The cost for each point. If you want to allow the product to be redeemed for a combination of points and currency, then enter the amount of money assigned as the cash value of one point. There is no default value, dependency, or limitation associated with this attribute.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The loyalty user that created the attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new member attribute. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new member attribute. There is no default value, dependency, or limitation associated with this attribute.
• CurrencyCode: integer (int64)
  Title: Currency

  The currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value or dependency associated with this attribute.
• CurrencyExchDt: string (date)
  Title: Currency Exchange Date

  The date when the attribute currency exchange takes place. This attribute displays the date of the currency exchange during the creation of promotion attributes. There is no default value, dependency, or limitation associated with this attribute.
• DataType: string
  Title: Data Type Meaning

  Read Only: true

  Maximum Length: 80

  The member attribute data type indicates whether the attribute is a string, or a number, and so on. During a transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value or limitation associated with this attribute.
• DataTypeCode: string
  Title: Data Type

  Maximum Length: 30

  The member attribute data type name indicates whether the attribute is a string, or number, and so on. During a transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.
• DefaultVal: string
  Title: Default Value

  Maximum Length: 75

  The default value that is used when the member attribute is created for a member, for the first time. There is no default, dependency, or limitation associated with this attribute.
• DescriptionText: string
  Title: Description

  Maximum Length: 1000

  The additional information pertaining to the attributes being used in promotion criteria. There is no default, dependency, or limitation associated with this attribute.
• DisplayFlag: boolean
  Title: Display

  Maximum Length: 1

  Default Value: true

  The boolean attribute that indicates whether the member attribute should be displayed or not, so that it can be used in the promotion criteria. The default value is Y. There is no dependency or limitation associated with this attribute.
• DisplayName: string
  Title: Name

  Maximum Length: 30

  The attribute display name that is displayed on the UI. There is no default value, dependency, or limitation associated with this attribute.
• DynamicFlag: boolean
  Title: Dynamic

  Maximum Length: 1

  Default Value: false

  The boolean attribute that indicates whether the member attribute value is calculated dynamically based on another attribute, which is used by the promotion criteria. The criteria can compare an attribute to a value or can compare an attribute to another attribute. The default value is N. There is no dependency or limitation associated with this attribute.
• ExpiryAlignCode: string
  Title: Expiration Aligned

  Maximum Length: 30

  The expiry alignment attribute provides details pertaining to the calculation of the expiry of points. There is no default value, dependency, or limitation associated with this attribute.
• ExpiryBasisCode: string
  Title: Expiration Basis

  Maximum Length: 30

  The basis for point or voucher expiry. The accepted values are Period (expires after a period of time) or Date (expires on a specific date). There is no default value, dependency, or limitation associated with this attribute.
• ExpiryDayCode: string
  Title: Expiration Day Code

  Maximum Length: 30

  The member attribute expiry day specifies the day of the month when the points expire, if the expiry basis is set to Date. This attribute is dependent on Expiry Basis Code. There is no default value or limitation associated with this attribute.
• ExpiryMonthCode: string
  Title: Expiration Month Code

  Maximum Length: 30

  The member attribute expiry month specifies the month when the points expire, if the expiry basis is set to Month. This attribute is dependent on Expiry Basis Code. There is no default value or limitation associated with this attribute.
• ExpPeriodLength: integer
  Title: Expiration Period Length

  The member attribute expiry period length is used to specify a length of time after when points expire. For example, if the points expire two years after they are earned, then the length is set to 2. After the points expire, the member can no longer exchange them for rewards. There is no default value, dependency, or limitation associated with this attribute.
• ExpPeriodUOMCode: string
  Title: Expiration Period Unit of Measure

  Maximum Length: 30

  The member attribute expiry period unit of measure (UOM), which is used to specify when points expire. For example, if the points expire a year or more after they are earned, UOM is set to Year. After the points expire, the member can no longer exchange the points for rewards. There is no default value, dependency, or limitation associated with this attribute.
• InternalName: string
  Title: Internal Name

  Maximum Length: 75

  The member attribute internal name. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the member attribute is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes to promotion attribute occur. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes happen to the member attribute. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user that last updated the member attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes take place to the promotion attributes. There is no default value, dependency, or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyAttrdefnBId: integer (int64)
  Title: Attribute Definition ID

  The primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• MergeAction: string
  Title: Merge Action Meaning

  Read Only: true

  Maximum Length: 80

  The attribute that indicates the merge action to be taken on a member attribute depending on the attribute data type.
• MergeActionCode: string
  Title: Merge Action

  Maximum Length: 30

  The member attribute merge action specifies how the program handles the attribute during a member merge. There is no default value, dependency, or limitation associated with this attribute.
• MethodName: string
  Title: Method Name

  Maximum Length: 75

  The method that is used in calculations of a promotion attribute value that can be used in promotion criteria. For example, the ORA_CAL_METHOD_MONTH_NAME method returns the month name. There is no default value, dependency, or limitation associated with this attribute.
• MinimumReactivationQuantity: number
  Title: Minimum Reactivation Quantity

  The minimum points needed to reactivate the expired points so that they can be used for redemption. There is no default value, dependency, or limitation associated with this attribute.
• MonthsLength: number
  Title: Months Length

  The numeric value that corresponds to the number of months during which points will expire. There is no default value, dependency, or limitation associated with this attribute.
• ObjectCode: string
  Title: Object Code

  Maximum Length: 30

  Default Value: Member

  The option to select values from entities such as Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.
• PickApplet: string
  Title: Pick Applet

  Maximum Length: 75

  The member attribute pick applet is a field whose values are entered using a dialog box. When defining criteria and actions, the dialog box with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.
• PickField: string
  Title: Pick Field

  Maximum Length: 75

  The pick field is the field whose value the user sees in the UI after selecting the field from the pick applet. There is no default value, dependency, or limitation associated with this attribute.
• PickFieldName: string
  Title: Pick Field Name

  Maximum Length: 75

  The member attribute pick field name is the user readable string of the PickField attribute. There is no default value, dependency, or limitation associated with this attribute.
• PickList: string
  Title: Pick List

  Maximum Length: 75

  The member attribute pick list that is enabled if the attribute values are entered using a picklist. When defining criteria and actions, the picklist with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.
• PrgFormulaId: integer (int64)
  Title: Program Formula ID

  The program formula identifier for the formula which can be used in criteria for comparisons and in actions for assigning values or updating attributes with the formula. The attribute is available for use by a promotion only if it is associated with the same program as that of the promotion. There is no default value, dependency, or limitation associated with this attribute.
• ProgramName: string
  Read Only: true

  The program for which member attribute is created. There is no default value, dependency, or limitation associated with this attribute.
• PromotionId: integer (int64)
  Title: Promotion ID

  The primary key of loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• PromotionName: string
  Read Only: true

  The name of loyalty promotion corresponding to the promotionId attribute. There is no default value, dependency, or limitation associated with this attribute.
• QualPointFlag: boolean
  Title: Qualifying Point

  Maximum Length: 1

  Default Value: false

  The member attribute qualifying point is a boolean attribute that indicates that the points accrued when the promotion gets applied count towards earning tier status, but cannot be redeemed for rewards. The default value is N. There is no dependency or limitation associated with this attribute.
• ReactivateFlag: boolean
  Title: Reactivate

  Maximum Length: 1

  Default Value: false

  The reactivate flag attribute reactivates members points after they have expired. The default value is N. There is no dependency or limitation associated with this attribute.
• ReadonlyFlag: boolean
  Title: Read Only

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the promotion attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.
• RetEffFlag: boolean
  Maximum Length: 1

  Default Value: false

  The member attribute effective start date attribute indicates the date when the attribute can be used in promotions. There is no default value, dependency, or limitation associated with this attribute.
• RptExpPdUOMCode: string
  Maximum Length: 30

  The unit of measure (UOM) for the time period until the expired points can be reactivated. The accepted values are Years, Months, Days, and so on. For example, if the reactivation expiry period is one year, then the unit of measure (UOM) is Year and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.
• RptExpPeriodLength: number
  The time period when the expired points can be reactivated. For example, if the reactivation expiry period is one year, then the time period length is 1 and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.
• TierClassId: integer (int64)
  Title: Tier Class ID

  The primary attribute of loyalty tier class that indicates the class to which a specific tier belongs. There is no default value, dependency, or limitation associated with this attribute.
• TierClassName: string
  Read Only: true

  The attribute that indicates the name of the tier class corresponding to tierClassId attribute. There is no default value, dependency, or limitation associated with this attribute.
• WeightFactor: number
  Title: Weight Factor

  The member attribute weight factor is used to determine which promotion is applied to the transaction, if multiple promotions qualify. There is no default value, dependency, or limitation associated with this attribute.
• WeightFactorNq: number
  Title: Weight Factor

  The member attribute weight factor non-qualifying attribute is used to determine whether to generate qualifying or non-qualifying points of each type when the weight factor attribute is specified. This attribute has a dependency on the Weight Factor attribute. There is no default value or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "WeightFactor":{
            "title":"Weight Factor",
            "type":"number",
            "description":"The member attribute weight factor is used to determine which promotion is applied to the transaction, if multiple promotions qualify. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new member attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionId":{
            "title":"Promotion ID",
            "type":"integer",
            "description":"The primary key of loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DefaultVal":{
            "title":"Default Value",
            "maxLength":75,
            "type":"string",
            "description":"The default value that is used when the member attribute is created for a member, for the first time. There is no default, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttrTypeCode":{
            "title":"Attribute Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The promotion attribute type code. This attribute reflects the attribute type, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":"Child Attribute",
            "x-queryable":true
        },
        "AttrDefnId":{
            "title":"Attribute Definition ID",
            "type":"integer",
            "description":"The primary key value of the loyalty attribute definitions corresponding to attribute types like pointType, Member, Transaction, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InternalName":{
            "title":"Internal Name",
            "maxLength":75,
            "type":"string",
            "description":"The member attribute internal name. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":30,
            "type":"string",
            "description":"The option to select values from entities such as Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":"Member",
            "x-queryable":true
        },
        "CancelActn":{
            "title":"Cancel Action Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The specification of which action must be applied during a transaction cancellation. The accepted values are Leave As Is (if selected, the value of the attribute remains the same when a transaction is cancelled), Revert, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "type":"integer",
            "description":"The currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value or dependency associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PromotionName":{
            "type":"string",
            "description":"The name of loyalty promotion corresponding to the promotionId attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RptExpPeriodLength":{
            "type":"number",
            "description":"The time period when the expired points can be reactivated. For example, if the reactivation expiry period is one year, then the time period length is 1 and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "QualPointFlag":{
            "title":"Qualifying Point",
            "maxLength":1,
            "type":"boolean",
            "description":"The member attribute qualifying point is a boolean attribute that indicates that the points accrued when the promotion gets applied count towards earning tier status, but cannot be redeemed for rewards. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MethodName":{
            "title":"Method Name",
            "maxLength":75,
            "type":"string",
            "description":"The method that is used in calculations of a promotion attribute value that can be used in promotion criteria. For example, the ORA_CAL_METHOD_MONTH_NAME method returns the month name. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes happen to the member attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The loyalty user that created the attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new member attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyExchDt":{
            "title":"Currency Exchange Date",
            "type":"string",
            "description":"The date when the attribute currency exchange takes place. This attribute displays the date of the currency exchange during the creation of promotion attributes. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramName":{
            "type":"string",
            "description":"The program for which member attribute is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the created member attribute 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
        },
        "ReactivateFlag":{
            "title":"Reactivate",
            "maxLength":1,
            "type":"boolean",
            "description":"The reactivate flag attribute reactivates members points after they have expired. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PickFieldName":{
            "title":"Pick Field Name",
            "maxLength":75,
            "type":"string",
            "description":"The member attribute pick field name is the user readable string of the PickField attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpiryMonthCode":{
            "title":"Expiration Month Code",
            "maxLength":30,
            "type":"string",
            "description":"The member attribute expiry month specifies the month when the points expire, if the expiry basis is set to Month. This attribute is dependent on Expiry Basis Code. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "WeightFactorNq":{
            "title":"Weight Factor",
            "type":"number",
            "description":"The member attribute weight factor non-qualifying attribute is used to determine whether to generate qualifying or non-qualifying points of each type when the weight factor attribute is specified. This attribute has a dependency on the Weight Factor attribute. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ReadonlyFlag":{
            "title":"Read Only",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the promotion attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PickList":{
            "title":"Pick List",
            "maxLength":75,
            "type":"string",
            "description":"The member attribute pick list that is enabled if the attribute values are entered using a picklist. When defining criteria and actions, the picklist with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayFlag":{
            "title":"Display",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that indicates whether the member attribute should be displayed or not, so that it can be used in the promotion criteria. The default value is Y. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "DataTypeCode":{
            "title":"Data Type",
            "maxLength":30,
            "type":"string",
            "description":"The member attribute data type name indicates whether the attribute is a string, or number, and so on. During a transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "RptExpPdUOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure (UOM) for the time period until the expired points can be reactivated. The accepted values are Years, Months, Days, and so on. For example, if the reactivation expiry period is one year, then the unit of measure (UOM) is Year and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last updated the member attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes take place to the promotion attributes. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostperPoint":{
            "type":"number",
            "description":"The cost for each point. If you want to allow the product to be redeemed for a combination of points and currency, then enter the amount of money assigned as the cash value of one point. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CancelActnCode":{
            "title":"Cancel Action",
            "maxLength":30,
            "type":"string",
            "description":"The specification of the action which must be applied during a transaction cancellation. The accepted values are Leave As Is (if selected, the value of the attribute remains the same when a transaction is cancelled), Revert, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MergeActionCode":{
            "title":"Merge Action",
            "maxLength":30,
            "type":"string",
            "description":"The member attribute merge action specifies how the program handles the attribute during a member merge. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PickField":{
            "title":"Pick Field",
            "maxLength":75,
            "type":"string",
            "description":"The pick field is the field whose value the user sees in the UI after selecting the field from the pick applet. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MergeAction":{
            "title":"Merge Action Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The attribute that indicates the merge action to be taken on a member attribute depending on the attribute data type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpPeriodLength":{
            "title":"Expiration Period Length",
            "type":"integer",
            "description":"The member attribute expiry period length is used to specify a length of time after when points expire. For example, if the points expire two years after they are earned, then the length is set to 2. After the points expire, the member can no longer exchange them for rewards. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumReactivationQuantity":{
            "title":"Minimum Reactivation Quantity",
            "type":"number",
            "description":"The minimum points needed to reactivate the expired points so that they can be used for redemption. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DynamicFlag":{
            "title":"Dynamic",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that indicates whether the member attribute value is calculated dynamically based on another attribute, which is used by the promotion criteria. The criteria can compare an attribute to a value or can compare an attribute to another attribute. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ExpPeriodUOMCode":{
            "title":"Expiration Period Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"The member attribute expiry period unit of measure (UOM), which is used to specify when points expire. For example, if the points expire a year or more after they are earned, UOM is set to Year. After the points expire, the member can no longer exchange the points for rewards. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The attribute display name that is displayed on the UI. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "TierClassId":{
            "title":"Tier Class ID",
            "type":"integer",
            "description":"The primary attribute of loyalty tier class that indicates the class to which a specific tier belongs. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DataType":{
            "title":"Data Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The member attribute data type indicates whether the attribute is a string, or a number, and so on. During a transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "RetEffFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The member attribute effective start date attribute indicates the date when the attribute can be used in promotions. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "MonthsLength":{
            "title":"Months Length",
            "type":"number",
            "description":"The numeric value that corresponds to the number of months during which points will expire. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "TierClassName":{
            "type":"string",
            "description":"The attribute that indicates the name of the tier class corresponding to tierClassId attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpiryBasisCode":{
            "title":"Expiration Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis for point or voucher expiry. The accepted values are Period (expires after a period of time) or Date (expires on a specific date). There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PickApplet":{
            "title":"Pick Applet",
            "maxLength":75,
            "type":"string",
            "description":"The member attribute pick applet is a field whose values are entered using a dialog box. When defining criteria and actions, the dialog box with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpiryAlignCode":{
            "title":"Expiration Aligned",
            "maxLength":30,
            "type":"string",
            "description":"The expiry alignment attribute provides details pertaining to the calculation of the expiry of points. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AccntActCode":{
            "title":"Account Activity",
            "maxLength":30,
            "type":"string",
            "description":"The member attribute account activity code. If this option is specified, then points expire if there is no activity of the type within the period specified for the point type. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpiryDayCode":{
            "title":"Expiration Day Code",
            "maxLength":30,
            "type":"string",
            "description":"The member attribute expiry day specifies the day of the month when the points expire, if the expiry basis is set to Date. This attribute is dependent on Expiry Basis Code. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LoyAttrdefnBId":{
            "title":"Attribute Definition ID",
            "type":"integer",
            "description":"The primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PrgFormulaId":{
            "title":"Program Formula ID",
            "type":"integer",
            "description":"The program formula identifier for the formula which can be used in criteria for comparisons and in actions for assigning values or updating attributes with the formula. The attribute is available for use by a promotion only if it is associated with the same program as that of the promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The additional information pertaining to the attributes being used in promotion criteria. There is no default, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "BusSvcName":{
            "title":"Business Service Name",
            "maxLength":75,
            "type":"string",
            "description":"The external business service that can be called in the promotion to evaluate business criteria. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the member attribute is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes to promotion attribute occur. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : loyPrograms-MemberFieldAttributes-item-response

Type: object

Show Source

• AccntActCode: string
  Title: Account Activity

  Maximum Length: 30

  The account activity code attribute. If this option is specified, then points expire when there is no activity of the type within the period specified for the point type. There is no default value, dependency, or limitation associated with this attribute.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the created member field attribute is enabled for use or not. The default value is N. There is no dependency or limitation associated with this attribute.
• AttrDefnId: integer (int64)
  Title: Attribute Definition ID

  The primary key value of the loyalty attribute definitions corresponding to attribute types such as pointType, Member, Transaction, and so on. There is no default value, dependency, or limitation associated with this attribute.
• AttrTypeCode: string
  Title: Attribute Type Code

  Maximum Length: 30

  Default Value: Field

  The member field attribute type code. This attribute reflects the type of the attribute, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.
• BusSvcName: string
  Title: Business Service Name

  Maximum Length: 75

  The external business service that can be called in a promotion for evaluation of business criteria. There is no default value, dependency, or limitation associated with this attribute.
• CancelActnCode: string
  Title: Cancel Action Code

  Maximum Length: 30

  The specification of which action must be applied during a transaction cancellation. The accepted values are Leave As Is (if selected, the value of the attribute remains the same when a transaction is cancelled), Revert, and so on. There is no default value, dependency, or limitation associated with this attribute.
• CostperPoint: number
  The cost for each point. If you want to allow the product to be redeemed for a combination of points and currency, then enter the amount of money assigned as the cash value of one point. There is no default value, dependency, or limitation associated with this attribute.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The loyalty user that created the attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new member field attribute. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new member field attribute. There is no default value, dependency, or limitation associated with this attribute.
• CurrencyCode: integer (int64)
  Title: Currency

  The currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value, dependency, or limitation associated with this attribute.
• CurrencyExchDt: string (date)
  Title: Currency Exchange Date

  The date when the member attribute currency exchange takes place. This attribute displays the date of the currency exchange during member attributes creation. There is no default value, dependency, or limitation associated with this attribute.
• DataType: string
  Title: Data Type Meaning

  Read Only: true

  Maximum Length: 80

  The member field attribute data type indicates whether the attribute is a string, or a number, and so on. During a transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value or limitation associated with this attribute.
• DataTypeCode: string
  Title: Data Type

  Maximum Length: 30

  The member field attribute data type name indicates whether the attribute is a string, or a number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.
• DefaultVal: string
  Title: Default Value

  Maximum Length: 75

  The default value that is used when the attribute is created for a member for the first time. There is no dependency or limitation associated with this attribute.
• DescriptionText: string
  Title: Description

  Maximum Length: 1000

  The additional information pertaining to the attributes being used in the promotion criteria. There is no dependency or limitation associated with this attribute.
• DisplayFlag: boolean
  Title: Display

  Maximum Length: 1

  Default Value: true

  The boolean attribute that indicates whether the member field attribute should be displayed or not, so that it can be used in the promotion criteria. The default value is Y. There is no dependency or limitation associated with this attribute.
• DisplayName: string
  Title: Name

  Maximum Length: 30

  The member attribute display name is the name that is displayed on the UI. There is no default value, dependency, or limitation associated with this attribute.
• DynamicFlag: boolean
  Title: Dynamic

  Maximum Length: 1

  Default Value: false

  The boolean attribute that indicates whether the member field attribute value is calculated dynamically based on another attribute that is used by the promotion criteria. The criteria can compare an attribute to a value or compare an attribute to another attribute. The default value is N. There is no dependency or limitation associated with this attribute.
• ExpiryAlignCode: string
  Title: Expiration Aligned

  Maximum Length: 30

  The expiry alignment attribute provides the details pertaining to the calculation of the expiry of points. There is no default value, dependency, or limitation associated with this attribute.
• ExpiryBasisCode: string
  Title: Expiration Basis

  Maximum Length: 30

  The basis for point or voucher expiry. The accepted values are Period (expires after a period of time) or Date (expires on a specific date). There is no default value, dependency, or limitation associated with this attribute.
• ExpiryDayCode: string
  Title: Expiration Day Code

  Maximum Length: 30

  The member field attribute expiry day specifies the day of the month when the points expire, if the expiry basis is set to Date. This attribute is dependent on Expiry Basis Code. There is no default value or limitation associated with this attribute.
• ExpiryMonthCode: string
  Title: Expiration Month Code

  Maximum Length: 30

  The member field attribute expiry month specifies the month when the points expire, if the expiry basis is set to Month. This attribute is dependent on Expiry Basis Code. There is no default value or limitation associated with this attribute. .
• ExpPeriodLength: integer
  Title: Expiration Period Length

  The member field attribute expiry period length is used to specify a length of time after when points expire. For example, if the points expire two years after they are earned, then the length is set to 2. After the points expire, the member can no longer exchange them for rewards. There is no default value, dependency, or limitation associated with this attribute.
• ExpPeriodUOMCode: string
  Title: Expiration Period Unit of Measure

  Maximum Length: 30

  The member field attribute expiry period unit of measure (UOM), which is used to specify when points expire. For example, if the points expire after they are earned, UOM is Year. After the points expire, the member can no longer exchange the points for rewards. There is no default value, dependency, or limitation associated with this attribute.
• InternalName: string
  Title: Field

  Maximum Length: 75

  The member field attribute internal name. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the attribute is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are changes to member field attributes. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are changes to the member field attributes. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are changes to the member field attributes. There is no default value, dependency, or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyAttrdefnBId: integer (int64)
  Title: Attribute Definition ID

  The primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• MergeActionCode: string
  Title: Merge Action

  Maximum Length: 30

  The member field attribute merge action specifies how the program handles the attribute during a member merge. There is no default value, dependency, or limitation associated with this attribute.
• MethodName: string
  Title: Method Name

  Maximum Length: 75

  The method that is used in calculations of promotion attribute values that can be used in promotion criteria. For example, the ORA_CAL_METHOD_MONTH_NAME method gives the month name. There is no default value, dependency, or limitation associated with this attribute.
• MinimumReactivationQuantity: number
  Title: Minimum Reactivation Quantity

  The minimum points needed to reactivate the expired points, so that they can be used for redemption. There is no default value, dependency, or limitation associated with this attribute.
• MonthsLength: number
  Title: Months Length

  The numeric value that corresponds to the number of months during which points will expire. There is no default value, dependency, or limitation associated with this attribute.
• ObjectCode: string
  Title: Object Code

  Maximum Length: 30

  Default Value: Member

  The option to select values from entities such as Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.
• PickApplet: string
  Title: Pick Applet

  Maximum Length: 75

  The member field attribute pick applet is a field whose values are entered using a dialog box. When defining criteria and actions, the dialog box with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.
• PickField: string
  Title: Pick Field

  Maximum Length: 75

  The pick field whose value the user sees in the UI after selecting from the pick applet. There is no default value, dependency, or limitation associated with this attribute.
• PickFieldName: string
  Title: Pick Field Name

  Maximum Length: 75

  The member field attribute pick field name is the user readable string of the PickField attribute. There is no default value, dependency, or limitation associated with this attribute.
• PickList: string
  Title: Pick List

  Maximum Length: 75

  The member field attribute pick list is enabled if the attribute is a field whose values are entered using a picklist. When defining criteria and actions, the picklist with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.
• PrgFormulaId: integer (int64)
  Title: Program Formula ID

  The program formula identifier that is available for use by the promotion, but only if it is associated with the same program as that of the program and promotion. The formula can be used in criteria for comparisons and in actions for assigning values or updating attributes with the formula value. There is no default value, dependency, or limitation associated with this attribute.
• ProgramName: string
  Read Only: true

  The program for which the member field attribute is created. There is no default value, dependency, or limitation associated with this attribute.
• PromotionId: integer (int64)
  Title: Promotion ID

  The primary key of loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• PromotionName: string
  Read Only: true

  The name of loyalty promotion corresponding to the promotionId attribute. There is no default value, dependency, or limitation associated with this attribute.
• QualPointFlag: boolean
  Title: Qualifying Point

  Maximum Length: 1

  Default Value: false

  The member field attribute qualifying point is a boolean attribute that indicates that the points accrued when the promotion gets applied count toward earning tier status, but cannot be redeemed for rewards. The default value is N. There is no dependency or limitation associated with this attribute.
• ReactivateFlag: boolean
  Title: Reactivate

  Maximum Length: 1

  Default Value: false

  The reactivate flag attribute reactivates members points after they have expired. The default value is N. There is no dependency or limitation associated with this attribute.
• ReadonlyFlag: boolean
  Title: Read Only

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the member field attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.
• RetEffFlag: boolean
  Maximum Length: 1

  Default Value: false

  The member field attribute effective start date indicates the date when the attribute can be used in promotions. There is no default value, dependency, or limitation associated with this attribute.
• RptExpPdUOMCode: string
  Maximum Length: 30

  The unit of measure (UOM) for the time period until the expired points can be reactivated. The accepted values are Years, Months, Days, and so on. For example, if the reactivation expiry period is one year, then the UOM is Year and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.
• RptExpPeriodLength: number
  The time period when the expired points can be reactivated. For example, if the reactivation expiry period is one year, then the time period length is 1 and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.
• TierClassId: integer (int64)
  Title: Tier Class ID

  The primary attribute of the loyalty tier class that indicates the class to which a specific tier belongs. There is no default value, dependency, or limitation associated with this attribute.
• TierClassName: string
  Read Only: true

  The attribute that indicates the name of the tier class corresponding to the tierClassId attribute. There is no default value, dependency, or limitation associated with this attribute.
• WeightFactor: number
  Title: Weight Factor

  The member field attribute weight factor is used to determine which promotion must be applied to the transaction, if multiple promotions qualify. There is no default value, dependency, or limitation associated with this attribute.
• WeightFactorNq: number
  Title: Weight Factor

  The member field attribute weight factor non-qualifying attribute is used to determine whether to generate qualifying or non-qualifying points of each type when the weight factor attribute is specified. There is no default value or limitation associated with this attribute. This attribute has a dependency on the Weight Factor attribute.

{
    "type":"object",
    "properties":{
        "WeightFactor":{
            "title":"Weight Factor",
            "type":"number",
            "description":"The member field attribute weight factor is used to determine which promotion must be applied to the transaction, if multiple promotions qualify. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new member field attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionId":{
            "title":"Promotion ID",
            "type":"integer",
            "description":"The primary key of loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DefaultVal":{
            "title":"Default Value",
            "maxLength":75,
            "type":"string",
            "description":"The default value that is used when the attribute is created for a member for the first time. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttrTypeCode":{
            "title":"Attribute Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The member field attribute type code. This attribute reflects the type of the attribute, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":"Field",
            "x-queryable":true
        },
        "AttrDefnId":{
            "title":"Attribute Definition ID",
            "type":"integer",
            "description":"The primary key value of the loyalty attribute definitions corresponding to attribute types such as pointType, Member, Transaction, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InternalName":{
            "title":"Field",
            "maxLength":75,
            "type":"string",
            "description":"The member field attribute internal name. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":30,
            "type":"string",
            "description":"The option to select values from entities such as Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":"Member",
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "type":"integer",
            "description":"The currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PromotionName":{
            "type":"string",
            "description":"The name of loyalty promotion corresponding to the promotionId attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RptExpPeriodLength":{
            "type":"number",
            "description":"The time period when the expired points can be reactivated. For example, if the reactivation expiry period is one year, then the time period length is 1 and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "QualPointFlag":{
            "title":"Qualifying Point",
            "maxLength":1,
            "type":"boolean",
            "description":"The member field attribute qualifying point is a boolean attribute that indicates that the points accrued when the promotion gets applied count toward earning tier status, but cannot be redeemed for rewards. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MethodName":{
            "title":"Method Name",
            "maxLength":75,
            "type":"string",
            "description":"The method that is used in calculations of promotion attribute values that can be used in promotion criteria. For example, the ORA_CAL_METHOD_MONTH_NAME method gives the month name. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are changes to the member field attributes. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The loyalty user that created the attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new member field attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyExchDt":{
            "title":"Currency Exchange Date",
            "type":"string",
            "description":"The date when the member attribute currency exchange takes place. This attribute displays the date of the currency exchange during member attributes creation. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramName":{
            "type":"string",
            "description":"The program for which the member field attribute is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the created member field attribute 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
        },
        "ReactivateFlag":{
            "title":"Reactivate",
            "maxLength":1,
            "type":"boolean",
            "description":"The reactivate flag attribute reactivates members points after they have expired. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PickFieldName":{
            "title":"Pick Field Name",
            "maxLength":75,
            "type":"string",
            "description":"The member field attribute pick field name is the user readable string of the PickField attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpiryMonthCode":{
            "title":"Expiration Month Code",
            "maxLength":30,
            "type":"string",
            "description":"The member field attribute expiry month specifies the month when the points expire, if the expiry basis is set to Month. This attribute is dependent on Expiry Basis Code. There is no default value or limitation associated with this attribute. .",
            "nullable":true,
            "x-queryable":true
        },
        "WeightFactorNq":{
            "title":"Weight Factor",
            "type":"number",
            "description":"The member field attribute weight factor non-qualifying attribute is used to determine whether to generate qualifying or non-qualifying points of each type when the weight factor attribute is specified. There is no default value or limitation associated with this attribute. This attribute has a dependency on the Weight Factor attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ReadonlyFlag":{
            "title":"Read Only",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the member field attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PickList":{
            "title":"Pick List",
            "maxLength":75,
            "type":"string",
            "description":"The member field attribute pick list is enabled if the attribute is a field whose values are entered using a picklist. When defining criteria and actions, the picklist with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayFlag":{
            "title":"Display",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that indicates whether the member field attribute should be displayed or not, so that it can be used in the promotion criteria. The default value is Y. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "DataTypeCode":{
            "title":"Data Type",
            "maxLength":30,
            "type":"string",
            "description":"The member field attribute data type name indicates whether the attribute is a string, or a number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "RptExpPdUOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure (UOM) for the time period until the expired points can be reactivated. The accepted values are Years, Months, Days, and so on. For example, if the reactivation expiry period is one year, then the UOM is Year and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are changes to the member field attributes. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostperPoint":{
            "type":"number",
            "description":"The cost for each point. If you want to allow the product to be redeemed for a combination of points and currency, then enter the amount of money assigned as the cash value of one point. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CancelActnCode":{
            "title":"Cancel Action Code",
            "maxLength":30,
            "type":"string",
            "description":"The specification of which action must be applied during a transaction cancellation. The accepted values are Leave As Is (if selected, the value of the attribute remains the same when a transaction is cancelled), Revert, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "MergeActionCode":{
            "title":"Merge Action",
            "maxLength":30,
            "type":"string",
            "description":"The member field attribute merge action specifies how the program handles the attribute during a member merge. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PickField":{
            "title":"Pick Field",
            "maxLength":75,
            "type":"string",
            "description":"The pick field whose value the user sees in the UI after selecting from the pick applet. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpPeriodLength":{
            "title":"Expiration Period Length",
            "type":"integer",
            "description":"The member field attribute expiry period length is used to specify a length of time after when points expire. For example, if the points expire two years after they are earned, then the length is set to 2. After the points expire, the member can no longer exchange them for rewards. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumReactivationQuantity":{
            "title":"Minimum Reactivation Quantity",
            "type":"number",
            "description":"The minimum points needed to reactivate the expired points, so that they can be used for redemption. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DynamicFlag":{
            "title":"Dynamic",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that indicates whether the member field attribute value is calculated dynamically based on another attribute that is used by the promotion criteria. The criteria can compare an attribute to a value or compare an attribute to another attribute. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ExpPeriodUOMCode":{
            "title":"Expiration Period Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"The member field attribute expiry period unit of measure (UOM), which is used to specify when points expire. For example, if the points expire after they are earned, UOM is Year. After the points expire, the member can no longer exchange the points for rewards. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The member attribute display name is the name that is displayed on the UI. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "TierClassId":{
            "title":"Tier Class ID",
            "type":"integer",
            "description":"The primary attribute of the loyalty tier class that indicates the class to which a specific tier belongs. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DataType":{
            "title":"Data Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The member field attribute data type indicates whether the attribute is a string, or a number, and so on. During a transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "RetEffFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The member field attribute effective start date indicates the date when the attribute can be used in promotions. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "MonthsLength":{
            "title":"Months Length",
            "type":"number",
            "description":"The numeric value that corresponds to the number of months during which points will expire. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "TierClassName":{
            "type":"string",
            "description":"The attribute that indicates the name of the tier class corresponding to the tierClassId attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpiryBasisCode":{
            "title":"Expiration Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis for point or voucher expiry. The accepted values are Period (expires after a period of time) or Date (expires on a specific date). There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PickApplet":{
            "title":"Pick Applet",
            "maxLength":75,
            "type":"string",
            "description":"The member field attribute pick applet is a field whose values are entered using a dialog box. When defining criteria and actions, the dialog box with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpiryAlignCode":{
            "title":"Expiration Aligned",
            "maxLength":30,
            "type":"string",
            "description":"The expiry alignment attribute provides the details pertaining to the calculation of the expiry of points. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AccntActCode":{
            "title":"Account Activity",
            "maxLength":30,
            "type":"string",
            "description":"The account activity code attribute. If this option is specified, then points expire when there is no activity of the type within the period specified for the point type. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpiryDayCode":{
            "title":"Expiration Day Code",
            "maxLength":30,
            "type":"string",
            "description":"The member field attribute expiry day specifies the day of the month when the points expire, if the expiry basis is set to Date. This attribute is dependent on Expiry Basis Code. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LoyAttrdefnBId":{
            "title":"Attribute Definition ID",
            "type":"integer",
            "description":"The primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PrgFormulaId":{
            "title":"Program Formula ID",
            "type":"integer",
            "description":"The program formula identifier that is available for use by the promotion, but only if it is associated with the same program as that of the program and promotion. The formula can be used in criteria for comparisons and in actions for assigning values or updating attributes with the formula value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The additional information pertaining to the attributes being used in the promotion criteria. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "BusSvcName":{
            "title":"Business Service Name",
            "maxLength":75,
            "type":"string",
            "description":"The external business service that can be called in a promotion for evaluation of business criteria. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the attribute is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are changes to member field attributes. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : loyPrograms-MemberTierAttributes-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the created member tier attribute is enabled for use or not. The default value is N. There is no dependency or limitation associated with this attribute.
• AttrTypeCode: string
  Title: Attribute Type Code

  Maximum Length: 30

  Default Value: Field

  The member tier attribute type code. This attribute reflects the type of the attribute, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.
• DataType: string
  Title: Data Type Meaning

  Read Only: true

  Maximum Length: 80

  The member tier attribute data type indicates whether the attribute is a string, or a number, and so on. During a transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value or limitation associated with this attribute.
• DataTypeCode: string
  Title: Data Type

  Maximum Length: 30

  The member tier attribute data type name indicates whether the attribute is a string, or a number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.
• DefaultVal: string
  Title: Default Value

  Maximum Length: 75

  The default value that is used when the attribute is created for a member for the first time. There is no dependency or limitation associated with this attribute.
• DescriptionText: string
  Title: Description

  Maximum Length: 1000

  The additional information pertaining to the member tier attribute. There is no default value, dependency, or limitation associated with this attribute.
• DisplayName: string
  Title: Name

  Maximum Length: 30

  The member tier attribute display name is what gets displayed on the UI. There is no default value, dependency, or limitation associated with this attribute.
• InternalName: string
  Title: Field

  Maximum Length: 75

  The member tier attribute internal name. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyAttrdefnBId: integer (int64)
  Title: Attribute Definition ID

  The primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• ObjectCode: string
  Title: Object Code

  Maximum Length: 30

  Default Value: Member Tier

  The option to select values from entities such as Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.
• PickApplet: string
  Title: Pick Applet

  Maximum Length: 75

  The member tier attribute pick applet is a field whose values are entered using a dialog box. When defining criteria and actions, the dialog box with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.
• PickField: string
  Title: Pick Field

  Maximum Length: 75

  The pick field whose value the user sees in the UI after selecting from the pick applet. There is no default value, dependency, or limitation associated with this attribute.
• PickFieldName: string
  Title: Pick Field Name

  Maximum Length: 75

  The member tier attribute pick field name is the user readable string of the PickField attribute. There is no default value, dependency, or limitation associated with this attribute.
• PickList: string
  Title: Pick List

  Maximum Length: 75

  The member tier attribute pick list is enabled if the attribute is a field whose values are entered using a picklist. When defining criteria and actions, the picklist with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.
• ProgramName: string
  Read Only: true

  The program for which the member tier attribute is created. There is no default value, dependency, or limitation associated with this attribute.
• ReadonlyFlag: boolean
  Title: Read Only

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the member tier attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "DefaultVal":{
            "title":"Default Value",
            "maxLength":75,
            "type":"string",
            "description":"The default value that is used when the attribute is created for a member for the first time. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PickApplet":{
            "title":"Pick Applet",
            "maxLength":75,
            "type":"string",
            "description":"The member tier attribute pick applet is a field whose values are entered using a dialog box. When defining criteria and actions, the dialog box with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttrTypeCode":{
            "title":"Attribute Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The member tier attribute type code. This attribute reflects the type of the attribute, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":"Field",
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":30,
            "type":"string",
            "description":"The option to select values from entities such as Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":"Member Tier",
            "x-queryable":true
        },
        "InternalName":{
            "title":"Field",
            "maxLength":75,
            "type":"string",
            "description":"The member tier attribute internal name. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramName":{
            "type":"string",
            "description":"The program for which the member tier attribute is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the created member tier attribute 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
        },
        "PickFieldName":{
            "title":"Pick Field Name",
            "maxLength":75,
            "type":"string",
            "description":"The member tier attribute pick field name is the user readable string of the PickField attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PickField":{
            "title":"Pick Field",
            "maxLength":75,
            "type":"string",
            "description":"The pick field whose value the user sees in the UI after selecting from the pick applet. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LoyAttrdefnBId":{
            "title":"Attribute Definition ID",
            "type":"integer",
            "description":"The primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The member tier attribute display name is what gets displayed on the UI. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ReadonlyFlag":{
            "title":"Read Only",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the member tier attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "DataType":{
            "title":"Data Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The member tier attribute data type indicates whether the attribute is a string, or a number, and so on. During a transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_TYPE":"Y"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PickList":{
            "title":"Pick List",
            "maxLength":75,
            "type":"string",
            "description":"The member tier attribute pick list is enabled if the attribute is a field whose values are entered using a picklist. When defining criteria and actions, the picklist with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The additional information pertaining to the member tier attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DataTypeCode":{
            "title":"Data Type",
            "maxLength":30,
            "type":"string",
            "description":"The member tier attribute data type name indicates whether the attribute is a string, or a number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : loyPrograms-NegativePoints-item-response

Type: object

Show Source

• AbsoluteValue: number
  Title: Absolute Value

  The attribute represents the absolute value of a negative points record. There is no default value, dependency, or limitation associated with this attribute.
• Basis: string
  Title: Basis Meaning

  Read Only: true

  Maximum Length: 80

  The attribute indicates the basis meaning of a negative points record. It can have either of two values as 'maximum' or 'minimum'. There is no default value, dependency, or limitation associated with this attribute.
• BasisCd: string
  Title: Basis

  Maximum Length: 30

  The attribute indicates the basis code meaning of a negative points record. It can have either of two values as 'maximum' or 'minimum'. There is no default value, dependency, or limitation associated with this attribute.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The loyalty user that created the negative points record. Oracle Loyalty Cloud generates this attribute value during the creation of a new negative points record. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Read Only: true

  The date when the negative points record is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new negative points record. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the negative points record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to negative points occur. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that last updated the negative points. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes happen to the negative points. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login details of the user that last updated the negative points record. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the negative points occur. There is no default value, dependency, or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PointBalancePercentage: number
  Title: Percentage

  This attribute shows the negative points allowed to a member as percentage of the point balance available. There is no any default value to it.
• PointTypeId: integer (int64)
  Title: Point Type

  The attribute is the unique point type identifier corresponding to the point type selected in a negative points record. There is no default value, dependency, or limitation associated with this attribute.
• PointTypeName: string
  The attribute indicates the name of the point type which is added for negative points. There is no default value, dependency, or limitation associated with this attribute.
• ProgNegPointId: integer (int64)
  The primary key of the loyalty negative points record. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• ProgramName: string
  Title: Program

  Read Only: true

  Maximum Length: 50

  The program for which the negative points record is created. There is no default value, dependency, or limitation associated with this attribute.
• TierClassId: integer (int64)
  Title: Tier Class

  The attribute is the unique tier class identifier corresponding to the tier class selected in a negative points record. There is no default value, dependency, or limitation associated with this attribute.
• TierClassName: string
  The attribute that indicates the name of the tier class with which the negative points record is created. There is no default value, dependency, or limitation associated with this attribute.
• TierId: integer (int64)
  Title: Tier

  The attribute is the unique tier identifier corresponding to the tier name selected in a negative points record. There is no default value, dependency, or limitation associated with this attribute.
• TierName: string
  The attribute that indicates the name of the tier associated with a negative points record. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the negative points. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes happen to the negative points. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the negative points record is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new negative points record. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AbsoluteValue":{
            "title":"Absolute Value",
            "type":"number",
            "description":"The attribute represents the absolute value of a negative points record. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The loyalty user that created the negative points record. Oracle Loyalty Cloud generates this attribute value during the creation of a new negative points record. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TierClassName":{
            "type":"string",
            "description":"The attribute that indicates the name of the tier class with which the negative points record is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "PointTypeName":{
            "type":"string",
            "description":"The attribute indicates the name of the point type which is added for negative points. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "ProgramName":{
            "title":"Program",
            "maxLength":50,
            "type":"string",
            "description":"The program for which the negative points record is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PointTypeId":{
            "title":"Point Type",
            "type":"integer",
            "description":"The attribute is the unique point type identifier corresponding to the point type selected in a negative points record. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "Basis":{
            "title":"Basis Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The attribute indicates the basis meaning of a negative points record. It can have either of two values as 'maximum' or 'minimum'. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_TYPE":"Y"
            },
            "x-queryable":true
        },
        "TierId":{
            "title":"Tier",
            "type":"integer",
            "description":"The attribute is the unique tier identifier corresponding to the tier name selected in a negative points record. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "PointBalancePercentage":{
            "title":"Percentage",
            "type":"number",
            "description":"This attribute shows the negative points allowed to a member as percentage of the point balance available. There is no any default value to it.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgNegPointId":{
            "type":"integer",
            "description":"The primary key of the loyalty negative points record. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "BasisCd":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The attribute indicates the basis code meaning of a negative points record. It can have either of two values as 'maximum' or 'minimum'. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TierClassId":{
            "title":"Tier Class",
            "type":"integer",
            "description":"The attribute is the unique tier class identifier corresponding to the tier class selected in a negative points record. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "TierName":{
            "type":"string",
            "description":"The attribute that indicates the name of the tier associated with a negative points record. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the negative points record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to negative points occur. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last updated the negative points record. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the negative points occur. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : loyPrograms-PointBlocks-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The loyalty user that created the point block. Oracle Loyalty Cloud generates this attribute value during the creation of a new point block record. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Read Only: true

  The date when the point block is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new point block record. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the point block record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the point block record occur. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that last updated the point block. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the point block. There is no dependency or limitation associated with this attribute.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login details of the user that last logged in. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the point block. There is no dependency or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 100

  The name of point block. There is no default value, dependency, or limitation associated with this attribute.
• OriginalPoints: number
  Title: Original Points

  The original points created under the point block. There is no default value, dependency, or limitation associated with this attribute.
• Partner: string
  Title: Partner

  The partner associated with the point block. There is no default value, dependency, or limitation associated with this attribute.
• PointBlockNumber: string
  Title: Point Block Number

  Maximum Length: 30

  The number of point block. There is no default value, dependency, or limitation associated with this attribute.
• ProgPointBlockId: integer (int64)
  The point block identifier created under the partner terms. There is no default value, dependency, or limitation associated with this attribute.
• ProgramName: string
  Read Only: true

  The name of program for which this point block is created. There is no default value, dependency, or limitation associated with this attribute.
• RemainingPoints: number
  Title: Remaining Points

  Read Only: true

  The remaining points from the point block. There is no default value, dependency, or limitation associated with this attribute.
• StartDate: string (date-time)
  Title: Start Date

  The start date for the point block. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the point block. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the point block. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PointBlockNumber":{
            "title":"Point Block Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of point block. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the point block is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new point block record. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginalPoints":{
            "title":"Original Points",
            "type":"number",
            "description":"The original points created under the point block. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The loyalty user that created the point block. Oracle Loyalty Cloud generates this attribute value during the creation of a new point block record. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgPointBlockId":{
            "type":"integer",
            "description":"The point block identifier created under the partner terms. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProgramName":{
            "type":"string",
            "description":"The name of program for which this point block is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of point block. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date for the point block. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RemainingPoints":{
            "title":"Remaining Points",
            "type":"number",
            "description":"The remaining points from the point block. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Partner":{
            "title":"Partner",
            "type":"string",
            "description":"The partner associated with the point block. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the point block record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the point block record occur. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last logged in. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the point block. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : loyPrograms-PointSubtypes-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The loyalty user that created the point subtype attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new point subtype attribute. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the point subtype is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new point subtype attribute. There is no default value, dependency, or limitation associated with this attribute.
• DefaultFlag: boolean
  Title: Default

  Maximum Length: 1

  Default Value: false

  The default value that is used when the attribute is created for a member for the first time. There is no dependency or limitation associated with this attribute.
• DescriptionText: string
  Title: Description

  Maximum Length: 100

  The additional information pertaining to the attributes being used in promotion criteria. There is no dependency or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the point subtype attribute is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to promotion attributes occur. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user that last updated the point subtype. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes to the promotion attributes occur. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user that last updated the point subtype. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the promotion attributes occur. There is no default value, dependency, or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyPtsubtypeId: integer (int64)
  Title: Loyalty Point Subtype ID

  The primary key of loyalty point subtypes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• Name: string
  Title: Name

  Maximum Length: 50

  The unique identifier of the point subtype. Point subtypes are used to keep track of the different reasons that the points are given out. For example, points can be given out as an incentive with purchases or as a bonus. In this case, point subtypes named Incentive and Bonus are created to track these two different reasons for the assignment of points to members. There is no default value, dependency, or limitation associated with this attribute.
• ProgramName: string
  Read Only: true

  The program for which the point subtype is created. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the point subtype. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes to the promotion attributes occur. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the point subtype is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new point subtype attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The loyalty user that created the point subtype attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new point subtype attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DefaultFlag":{
            "title":"Default",
            "maxLength":1,
            "type":"boolean",
            "description":"The default value that is used when the attribute is created for a member for the first time. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The additional information pertaining to the attributes being used in promotion criteria. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LoyPtsubtypeId":{
            "title":"Loyalty Point Subtype ID",
            "type":"integer",
            "description":"The primary key of loyalty point subtypes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProgramName":{
            "type":"string",
            "description":"The program for which the point subtype is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the point subtype attribute is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to promotion attributes occur. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last updated the point subtype. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the promotion attributes occur. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the point subtype. Point subtypes are used to keep track of the different reasons that the points are given out. For example, points can be given out as an incentive with purchases or as a bonus. In this case, point subtypes named Incentive and Bonus are created to track these two different reasons for the assignment of points to members. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : loyPrograms-PointTotalsAttributes-item-response

Type: object

Show Source

• AccntActCode: string
  Title: Account Activity

  Maximum Length: 30

  The point totals attribute account activity code. If this option is specified, then points expire if there is no activity of the type within the period specified for the point type. There is no default value, dependency, or limitation associated with this attribute.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the created point total attribute is enabled for use or not. The default value is N. There is no dependency or limitation associated with this attribute.
• AttrDefnId: integer (int64)
  Title: Point Type

  The primary key value of the loyalty attribute definitions corresponding to attribute types like pointType, Member, Transaction, and so on There is no default value, dependency, or limitation associated with this attribute.
• AttrTypeCode: string
  Title: Attribute Type Code

  Maximum Length: 30

  Default Value: Point Total

  The point totals attribute type code reflects the type of the attribute, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.
• BusSvcName: string
  Title: Business Service Name

  Maximum Length: 75

  The external business service that can be called in a promotion for evaluating business criteria. There is no default value, dependency, or limitation associated with this attribute.
• CancelActnCode: string
  Title: Cancel Action Code

  Maximum Length: 30

  The specification of the action that must be applied during a transaction cancellation. The accepted values are Leave As Is (if selected, the value of the attribute remains the same when a transaction is cancelled), Revert, and so on. There is no default value, dependency, or limitation associated with this attribute.
• CostperPoint: number
  The cost for each point. If you want to allow the product to be redeemed for a combination of points and currency, then enter the amount of money assigned as the cash value of one point. There is no default value, dependency, or limitation associated with this attribute.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The loyalty user that created the point totals attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new point totals attribute. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the point totals attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new point totals attribute. There is no default value, dependency, or limitation associated with this attribute.
• CurrencyCode: integer (int64)
  Title: Currency

  The currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value, dependency, or limitation associated with this attribute.
• CurrencyExchDt: string (date)
  Title: Currency Exchange Date

  The date when the point totals attribute currency exchange takes place. This attribute displays the date of the currency exchange during the creation of the point totals attribute. There is no default value, dependency, or limitation associated with this attribute.
• DataType: string
  Title: Data Type Meaning

  Read Only: true

  Maximum Length: 80

  The point total attribute data type indicates whether the attribute is a string, or a number, and so on. During a transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value or limitation associated with this attribute.
• DataTypeCode: string
  Title: Data Type

  Maximum Length: 30

  Default Value: ORA_ATTRIB_NUM_DATA_TYPE

  The point totals attribute data type name indicates whether the attribute is a string, or a number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.
• DefaultValue: string
  Title: Default Value

  Maximum Length: 75

  The default value that is used when the attribute is created for a member for the first time. There is no dependency or limitation associated with this attribute.
• DescriptionText: string
  Title: Description

  Maximum Length: 1000

  The additional information pertaining to the attributes being used in promotion criteria. There is no dependency or limitation associated with this attribute.
• DisplayFlag: boolean
  Title: Display

  Maximum Length: 1

  Default Value: false

  The boolean attribute that indicates whether the point totals attribute should be displayed or not, so that it can be used in the promotion criteria. The default value is Y. There is no dependency or limitation associated with this attribute.
• DisplayName: string
  Title: Name

  Maximum Length: 30

  The point subtype attribute display name that is displayed on the UI. There is no default value, dependency, or limitation associated with this attribute.
• DynamicFlag: boolean
  Title: Dynamic

  Maximum Length: 1

  Default Value: false

  The boolean attribute that indicates whether the attribute value is calculated dynamically based on another attribute, which is used by the promotion criteria. The criteria can compare an attribute to a value or compare an attribute to another attribute. The default value is N. There is no dependency or limitation associated with this attribute.
• ExpiryAlignCode: string
  Title: Expiration Aligned

  Maximum Length: 30

  The expiry alignment attribute provides details pertaining to the calculation of the expiry of points. There is no default value, dependency, or limitation associated with this attribute.
• ExpiryBasisCode: string
  Title: Expiration Basis

  Maximum Length: 30

  The basis for point or voucher expiry. The accepted values are Period (expires after a period of time) or Date (expires on a specific date). There is no default value, dependency, or limitation associated with this attribute.
• ExpiryDayCode: string
  Title: Expiration Day Code

  Maximum Length: 30

  The point totals attribute expiry day specifies the day of the month when the points expire if the expiry basis is Date. There is no default value or limitation associated with this attribute. This attribute is dependent on Expiry Basis Code.
• ExpiryMonthCode: string
  Title: Expiration Month Code

  Maximum Length: 30

  The point totals attribute expiry month specifies the month when the points expire if the expiry basis is Month. There is no default value or limitation associated with this attribute. This attribute is dependent on Expiry Basis Code.
• ExpPeriodLength: integer
  Title: Expiration Period Length

  The expiry period length attribute is used to specify a length of time after when points expire. For example, if the points expire two years after they are earned, then the length is set to 2. After the points expire, the member can no longer exchange them for rewards. There is no default value, dependency, or limitation associated with this attribute.
• ExpPeriodUOM: string
  Title: Period UOM Meaning

  Read Only: true

  Maximum Length: 80

  The point totals attribute expiry period unit of measure (UOM) is used to specify when points expire. The possible values of this UOM are Days, Months, Quarters and Year. After the points expire, the member can no longer exchange the points for rewards. There is no default value, dependency, or limitation associated with this attribute.
• ExpPeriodUOMCode: string
  Title: Period UOM

  Maximum Length: 30

  The point totals attribute expiry period unit of measure (UOM) is used to specify when points expire. The possible values of this UOM code are Days, Months, Quarters and Year. After the points expire, the member can no longer exchange the points for rewards. There is no default value, dependency, or limitation associated with this attribute.
• InternalName: string
  Title: Internal Name

  Maximum Length: 75

  Default Value: Internal

  The point totals attribute internal name. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the attribute is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes to the promotion attributes occur. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are any changes to the promotion attributes. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes take place to the promotion attributes. There is no default value, dependency, or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyAttrdefnBId: integer (int64)
  Title: Attribute Definition ID

  The primary key of the loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• MergeActionCode: string
  Title: Merge Action

  Maximum Length: 30

  The merge action attribute specifies how the program handles the attribute during a member merge. There is no default value, dependency, or limitation associated with this attribute.
• MethodName: string
  Title: Method Name

  Maximum Length: 75

  The method that is used in the calculation of the promotion attribute value that can be used in promotion criteria. For example, the ORA_CAL_METHOD_MONTH_NAME method returns the month name. There is no default value, dependency, or limitation associated with this attribute.
• MinimumReactivationQuantity: number
  Title: Minimum Reactivation Quantity

  The minimum number of points needed to reactivate the expired points so that they can be used for redemption. There is no default value, dependency, or limitation associated with this attribute.
• MonthsLen: number
  Title: Period Quantity

  The numeric value that corresponds to the number of months during which points will expire. There is no default value, dependency, or limitation associated with this attribute.
• ObjectCode: string
  Title: Object Code

  Maximum Length: 30

  Default Value: Member

  The option to select values from entities such as Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.
• PickApplet: string
  Title: Pick Applet

  Maximum Length: 75

  The pick applet attribute is a field whose values are entered using a dialog box. When defining criteria and actions, the dialog box with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.
• PickField: string
  Title: Pick Field

  Maximum Length: 75

  The pick field whose value the user sees in the UI after selecting from the pick applet. There is no default value, dependency, or limitation associated with this attribute.
• PickFieldName: string
  Title: Pick Field Name

  Maximum Length: 75

  The pick field name attribute is the user readable string of the PickField attribute. There is no default value, dependency, or limitation associated with this attribute.
• PickList: string
  Title: Pick List

  Maximum Length: 75

  The pick list attribute is enabled if the attribute is a field whose values are entered using a picklist. When defining criteria and actions, the picklist with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.
• PrgFormulaId: integer (int64)
  Title: Program Formula ID

  The program formula identifier that is available for use by a promotion only if it is associated with the same program as the program for the promotion. The formula can be used in criteria for comparisons and in actions for assigning values or updating attributes with the formula value. There is no default value, dependency, or limitation associated with this attribute.
• ProgramName: string
  Read Only: true

  The program for which the point totals attribute is created. There is no default value, dependency, or limitation associated with this attribute.
• PromotionId: integer (int64)
  Title: Promotion ID

  The primary key of loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• PromotionName: string
  Read Only: true

  The name of the promotion corresponding to the promotionId attribute. There is no default value, dependency, or limitation associated with this attribute.
• QualPointFlag: boolean
  Title: Qualifying Point

  Maximum Length: 1

  Default Value: false

  The point totals qualifying point attribute is a boolean attribute that indicates that the points accrued when the promotion gets applied count toward earning tier status, but are not redeemed for rewards. The default value is N. There is no dependency or limitation associated with this attribute.
• ReactivateFlag: boolean
  Title: Reactivate

  Maximum Length: 1

  Default Value: false

  The reactivate flag attribute reactivates members points after they have expired. The default value is N. There is no dependency or limitation associated with this attribute.
• ReadonlyFlag: boolean
  Title: Read Only

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the point total attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.
• RetEffFlag: boolean
  Maximum Length: 1

  Default Value: false

  The effective start date attribute specifies the date when the attribute can be used in promotions. There is no default value, dependency, or limitation associated with this attribute.
• RptExpPdUOMCode: string
  Maximum Length: 30

  The unit of measure (UOM) for the time period until the expired points can be reactivated. The accepted values are Years, Months, Days, and so on. For example, if the reactivation expiry period is one year, then the UOM is Year and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.
• RptExpPeriodLength: number
  The time period when the expired points can be reactivated. For example, if the reactivation expiry period is one year, then the time period length is 1 and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.
• TierClassId: integer (int64)
  Title: Tier Class ID

  The primary attribute of the loyalty tier class, which indicates the class in which a specific tier belongs. There is no default value, dependency, or limitation associated with this attribute.
• TierClassName: string
  Read Only: true

  The attribute that indicates the name of the tier class corresponding to the tierClassId attribute. There is no default value, dependency, or limitation associated with this attribute.
• WeightFactor: number
  Title: Weight Factor

  The weight factor attribute is used to determine which promotion must be applied to the transaction, if multiple promotions qualify. There is no default value, dependency, or limitation associated with this attribute.
• WeightFactorNq: number
  Title: Weight Factor

  The weight factor non-qualifying attribute is used to determine whether to generate qualifying or non-qualifying points of each type when the weight factor attribute is specified. This attribute has a dependency on the Weight Factor attribute. There is no default value or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "WeightFactor":{
            "title":"Weight Factor",
            "type":"number",
            "description":"The weight factor attribute is used to determine which promotion must be applied to the transaction, if multiple promotions qualify. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the point totals attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new point totals attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MonthsLen":{
            "title":"Period Quantity",
            "type":"number",
            "description":"The numeric value that corresponds to the number of months during which points will expire. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PromotionId":{
            "title":"Promotion ID",
            "type":"integer",
            "description":"The primary key of loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttrTypeCode":{
            "title":"Attribute Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The point totals attribute type code reflects the type of the attribute, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":"Point Total",
            "x-queryable":true
        },
        "AttrDefnId":{
            "title":"Point Type",
            "type":"integer",
            "description":"The primary key value of the loyalty attribute definitions corresponding to attribute types like pointType, Member, Transaction, and so on There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "InternalName":{
            "title":"Internal Name",
            "maxLength":75,
            "type":"string",
            "description":"The point totals attribute internal name. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":"Internal",
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":30,
            "type":"string",
            "description":"The option to select values from entities such as Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":"Member",
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "type":"integer",
            "description":"The currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PromotionName":{
            "type":"string",
            "description":"The name of the promotion corresponding to the promotionId attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RptExpPeriodLength":{
            "type":"number",
            "description":"The time period when the expired points can be reactivated. For example, if the reactivation expiry period is one year, then the time period length is 1 and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "QualPointFlag":{
            "title":"Qualifying Point",
            "maxLength":1,
            "type":"boolean",
            "description":"The point totals qualifying point attribute is a boolean attribute that indicates that the points accrued when the promotion gets applied count toward earning tier status, but are not redeemed for rewards. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MethodName":{
            "title":"Method Name",
            "maxLength":75,
            "type":"string",
            "description":"The method that is used in the calculation of the promotion attribute value that can be used in promotion criteria. For example, the ORA_CAL_METHOD_MONTH_NAME method returns the month name. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are any changes to the promotion attributes. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The loyalty user that created the point totals attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new point totals attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyExchDt":{
            "title":"Currency Exchange Date",
            "type":"string",
            "description":"The date when the point totals attribute currency exchange takes place. This attribute displays the date of the currency exchange during the creation of the point totals attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramName":{
            "type":"string",
            "description":"The program for which the point totals attribute is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the created point total attribute 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
        },
        "ReactivateFlag":{
            "title":"Reactivate",
            "maxLength":1,
            "type":"boolean",
            "description":"The reactivate flag attribute reactivates members points after they have expired. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PickFieldName":{
            "title":"Pick Field Name",
            "maxLength":75,
            "type":"string",
            "description":"The pick field name attribute is the user readable string of the PickField attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpiryMonthCode":{
            "title":"Expiration Month Code",
            "maxLength":30,
            "type":"string",
            "description":"The point totals attribute expiry month specifies the month when the points expire if the expiry basis is Month. There is no default value or limitation associated with this attribute. This attribute is dependent on Expiry Basis Code.",
            "nullable":true,
            "x-queryable":true
        },
        "WeightFactorNq":{
            "title":"Weight Factor",
            "type":"number",
            "description":"The weight factor non-qualifying attribute is used to determine whether to generate qualifying or non-qualifying points of each type when the weight factor attribute is specified. This attribute has a dependency on the Weight Factor attribute. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ReadonlyFlag":{
            "title":"Read Only",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the point total attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PickList":{
            "title":"Pick List",
            "maxLength":75,
            "type":"string",
            "description":"The pick list attribute is enabled if the attribute is a field whose values are entered using a picklist. When defining criteria and actions, the picklist with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayFlag":{
            "title":"Display",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that indicates whether the point totals attribute should be displayed or not, so that it can be used in the promotion criteria. The default value is Y. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "DataTypeCode":{
            "title":"Data Type",
            "maxLength":30,
            "type":"string",
            "description":"The point totals attribute data type name indicates whether the attribute is a string, or a number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":"ORA_ATTRIB_NUM_DATA_TYPE",
            "x-queryable":true
        },
        "RptExpPdUOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure (UOM) for the time period until the expired points can be reactivated. The accepted values are Years, Months, Days, and so on. For example, if the reactivation expiry period is one year, then the UOM is Year and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes take place to the promotion attributes. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostperPoint":{
            "type":"number",
            "description":"The cost for each point. If you want to allow the product to be redeemed for a combination of points and currency, then enter the amount of money assigned as the cash value of one point. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CancelActnCode":{
            "title":"Cancel Action Code",
            "maxLength":30,
            "type":"string",
            "description":"The specification of the action that must be applied during a transaction cancellation. The accepted values are Leave As Is (if selected, the value of the attribute remains the same when a transaction is cancelled), Revert, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "MergeActionCode":{
            "title":"Merge Action",
            "maxLength":30,
            "type":"string",
            "description":"The merge action attribute specifies how the program handles the attribute during a member merge. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PickField":{
            "title":"Pick Field",
            "maxLength":75,
            "type":"string",
            "description":"The pick field whose value the user sees in the UI after selecting from the pick applet. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultValue":{
            "title":"Default Value",
            "maxLength":75,
            "type":"string",
            "description":"The default value that is used when the attribute is created for a member for the first time. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpPeriodLength":{
            "title":"Expiration Period Length",
            "type":"integer",
            "description":"The expiry period length attribute is used to specify a length of time after when points expire. For example, if the points expire two years after they are earned, then the length is set to 2. After the points expire, the member can no longer exchange them for rewards. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumReactivationQuantity":{
            "title":"Minimum Reactivation Quantity",
            "type":"number",
            "description":"The minimum number of points needed to reactivate the expired points so that they can be used for redemption. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DynamicFlag":{
            "title":"Dynamic",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that indicates whether the attribute value is calculated dynamically based on another attribute, which is used by the promotion criteria. The criteria can compare an attribute to a value or compare an attribute to another attribute. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ExpPeriodUOMCode":{
            "title":"Period UOM",
            "maxLength":30,
            "type":"string",
            "description":"The point totals attribute expiry period unit of measure (UOM) is used to specify when points expire. The possible values of this UOM code are Days, Months, Quarters and Year. After the points expire, the member can no longer exchange the points for rewards. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The point subtype attribute display name that is displayed on the UI. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "TierClassId":{
            "title":"Tier Class ID",
            "type":"integer",
            "description":"The primary attribute of the loyalty tier class, which indicates the class in which a specific tier belongs. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DataType":{
            "title":"Data Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The point total attribute data type indicates whether the attribute is a string, or a number, and so on. During a transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_TYPE":"Y"
            },
            "x-queryable":true
        },
        "RetEffFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The effective start date attribute specifies the date when the attribute can be used in promotions. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "TierClassName":{
            "type":"string",
            "description":"The attribute that indicates the name of the tier class corresponding to the tierClassId attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpiryBasisCode":{
            "title":"Expiration Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis for point or voucher expiry. The accepted values are Period (expires after a period of time) or Date (expires on a specific date). There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PickApplet":{
            "title":"Pick Applet",
            "maxLength":75,
            "type":"string",
            "description":"The pick applet attribute is a field whose values are entered using a dialog box. When defining criteria and actions, the dialog box with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpiryAlignCode":{
            "title":"Expiration Aligned",
            "maxLength":30,
            "type":"string",
            "description":"The expiry alignment attribute provides details pertaining to the calculation of the expiry of points. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AccntActCode":{
            "title":"Account Activity",
            "maxLength":30,
            "type":"string",
            "description":"The point totals attribute account activity code. If this option is specified, then points expire if there is no activity of the type within the period specified for the point type. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpiryDayCode":{
            "title":"Expiration Day Code",
            "maxLength":30,
            "type":"string",
            "description":"The point totals attribute expiry day specifies the day of the month when the points expire if the expiry basis is Date. There is no default value or limitation associated with this attribute. This attribute is dependent on Expiry Basis Code.",
            "nullable":true,
            "x-queryable":true
        },
        "LoyAttrdefnBId":{
            "title":"Attribute Definition ID",
            "type":"integer",
            "description":"The primary key of the loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PrgFormulaId":{
            "title":"Program Formula ID",
            "type":"integer",
            "description":"The program formula identifier that is available for use by a promotion only if it is associated with the same program as the program for the promotion. The formula can be used in criteria for comparisons and in actions for assigning values or updating attributes with the formula value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExpPeriodUOM":{
            "title":"Period UOM Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The point totals attribute expiry period unit of measure (UOM) is used to specify when points expire. The possible values of this UOM are Days, Months, Quarters and Year. After the points expire, the member can no longer exchange the points for rewards. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The additional information pertaining to the attributes being used in promotion criteria. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "BusSvcName":{
            "title":"Business Service Name",
            "maxLength":75,
            "type":"string",
            "description":"The external business service that can be called in a promotion for evaluating business criteria. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the attribute is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes to the promotion attributes occur. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : loyPrograms-PointTypes-item-response

Type: object

Show Source

• AccntActCode: string
  Title: Activity

  Maximum Length: 30

  The point type account activity code. If this option is specified, then points expire if there is no activity of the type within the period specified for the point type. There is no default value, dependency, or limitation associated with this attribute.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the created point type attribute is enabled for use or not. The default value is N. There is no dependency or limitation associated with this attribute.
• AttrDefnId: integer (int64)
  Title: Attribute Definition ID

  The primary key value of the loyalty attribute definitions corresponding to attribute types such as pointType, Member, Transaction, and so on. There is no default value, dependency, or limitation associated with this attribute.
• AttrTypeCode: string
  Title: Attribute Type Code

  Maximum Length: 30

  The point type attribute type code. This attribute reflects the type of the attribute, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.
• BusSvcName: string
  Title: Business Service Name

  Maximum Length: 75

  The external business service that can be called in a promotion for the evaluation of business criteria. There is no default value, dependency, or limitation associated with this attribute.
• CancelActnCode: string
  Title: Cancel Action Code

  Maximum Length: 30

  The specification of which action must be applied during a transaction cancellation. The accepted values are Leave As Is (if selected, the value of the attribute remains the same when a transaction is cancelled), Revert, and so on. There is no default value, dependency, or limitation associated with this attribute.
• CostPERPoint: number
  Title: Cost per Point

  The cost for each point. If you want to allow the product to be redeemed for a combination of points and currency, then enter the amount of money assigned as the cash value of one point. There is no default value, dependency, or limitation associated with this attribute.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The loyalty user that created the promotion attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new promotion attribute. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the point type attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new point type attribute. There is no default value, dependency, or limitation associated with this attribute.
• CurrencyCode: integer (int64)
  Title: Currency

  The currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value, dependency, or limitation associated with this attribute.
• CurrencyExchDt: string (date)
  Title: Currency Exchange Date

  The date when the point type attribute currency exchange takes place. This attribute displays the date of the currency exchange during the creation of the point type attribute. There is no default value, dependency, or limitation associated with this attribute.
• DataTypeCode: string
  Title: Data Type

  Maximum Length: 30

  The point type attribute data type code indicates whether the attribute is a string, or number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.
• DataTypeMeaning: string
  Title: Data Type Meaning

  Read Only: true

  The data type meaning attribute indicates whether the attribute is a string, or a number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.
• DefaultValue: string
  Title: Default Value

  Maximum Length: 75

  The default value that is used when the attribute is created for a member for the first time. There is no dependency or limitation associated with this attribute.
• DescriptionText: string
  Title: Description

  Maximum Length: 1000

  The additional details that pertain to the point type. There is no default value, dependency associated with this attribute.
• DisplayFlag: boolean
  Title: Display

  Maximum Length: 1

  Default Value: true

  The boolean attribute that indicates whether the point type attribute should be displayed or not, so that it can be used in the promotion criteria. The default value is Y. There is no dependency or limitation associated with this attribute.
• DisplayName: string
  Title: Name

  Maximum Length: 30

  The point types attribute display name that is displayed to the user. There is no default value, dependency, or limitation associated with this attribute.
• DynamicFlag: boolean
  Title: Dynamic

  Maximum Length: 1

  Default Value: false

  The boolean attribute that indicates whether the attribute value is calculated dynamically based on another attribute, which is used by the promotion criteria. The criteria can compare an attribute to a value or compare an attribute to another attribute. The default value is N. There is no dependency or limitation associated with this attribute.
• ExpiryAdjustmentMeaning: string
  Read Only: true

  The blocks of points having different expiration dates and sales prices that are created at the time of credit. When members accrue points, these point blocks are debited based on a pricing rule, with the earliest expiration dates debited first. These point blocks require adjustment if there are errors in crediting or debiting point balances. There is no default value, dependency, or limitation associated with this attribute.
• ExpiryBasisCode: string
  Title: Expiry Basis

  Maximum Length: 30

  The basis code for point type expiry. The accepted values are ORA_PT_EX_ACC_ACT, ORA_PT_EX_PERIOD. There is no default value, dependency, or limitation associated with this attribute.
• ExpiryBasisMeaning: string
  Read Only: true

  The basis for point type expiry. The accepted values are Account Activity (points expire if there is no activity of the type and in the period specified for the point type), Period (expires after a period of time), Fixed Day or Fixed Month (specify the day and month when points expire). There is no default value, dependency, or limitation associated with this attribute.
• ExpiryDayCode: string
  Title: Expiration Day Code

  Maximum Length: 30

  The expiry day attribute specifies the day of the month when the points expire if the expiry basis is Date. This attribute is dependent on Expiry Basis Code. There is no default value or limitation associated with this attribute.
• ExpiryMonthCode: string
  Title: Expiration Month Code

  Maximum Length: 30

  The expiry month attribute specifies the month when the points expire if the expiry basis is Month. This attribute is dependent on Expiry Basis Code. There is no default value or limitation associated with this attribute.
• ExpPeriodLen: integer
  Title: Period Quantity

  The expiry period length attribute is used to specify a length of time after when points expire. For example, if the points expire two years after they are earned, then the length is set to 2. After the points expire, the member can no longer exchange them for rewards. There is no default value, dependency, or limitation associated with this attribute.
• InternalName: string
  Title: Internal Name

  Maximum Length: 75

  The point type attribute internal name. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the point type attribute is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the promotion attributes occur. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the point type attributes occur. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the point type attributes occur. There is no default value, dependency, or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyAttrdefnBId: integer (int64)
  Title: Attribute Definition ID

  The primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• MergeActionCode: string
  Title: Merge Action

  Maximum Length: 30

  The attribute merge action specifies how the program handles the attribute during a member merge. There is no default value, dependency, or limitation associated with this attribute.
• MethodName: string
  Title: Method Name

  Maximum Length: 75

  The method that is used in the calculation of the point type attribute value that can be used in a promotion criteria. For example, the ORA_CAL_METHOD_MONTH_NAME method returns the month name. There is no default value, dependency, or limitation associated with this attribute.
• MinimumReactivationQuantity: number
  Title: Minimum Reactivation Quantity

  The minimum points required to reactivate the expired points so that they can be used for redemption. There is no default value, dependency, or limitation associated with this attribute.
• MonthsLength: number
  Title: Months Length

  The numeric value that corresponds to the number of months during which points will expire. There is no default value, dependency, or limitation associated with this attribute.
• ObjectCode: string
  Title: Object Code

  Maximum Length: 30

  The option to select values from entities such as Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.
• PeriodUOMMeaning: string
  Read Only: true

  The point type period unit of measure. Period type options are Days, Months, Quarters, Years, and so on. There is no default value, dependency, or limitation associated with this attribute.
• PickApplet: string
  Title: Pick Applet

  Maximum Length: 75

  The point type pick applet attribute is a field whose values are entered using a dialog box. When defining criteria and actions, the dialog box with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.
• PickField: string
  Title: Pick Field

  Maximum Length: 75

  The pick field whose value the user sees in the UI after selecting from the pick applet. There is no default value, dependency, or limitation associated with this attribute.
• PickFieldName: string
  Title: Pick Field Name

  Maximum Length: 75

  The pick field name attribute is the user readable string of the attribute PickField. There is no default value, dependency, or limitation associated with this attribute.
• PickList: string
  Title: Pick List

  Maximum Length: 75

  The pick list attribute is enabled if the attribute is a field whose values are entered using a picklist. When defining criteria and actions, the picklist with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.
• PointActivityMeaning: string
  Read Only: true

  The point type activity options are Accrual, Redemption, or Accrual/Redemption. This field is activated only if the point expiry basis is account activity. There is no default value, dependency, or limitation associated with this attribute.
• PrgFormulaId: integer (int64)
  Title: Program Formula ID

  The program formula identifier that is available for use by a promotion, but only if it is associated with the same program as the program for the promotion. The formula can be used in criteria for comparisons and in actions for assigning values or updating attributes with the formula value. There is no default value, dependency, or limitation associated with this attribute.
• ProgramName: string
  Read Only: true

  The program for which the point type is created. There is no default value, dependency, or limitation associated with this attribute.
• PromotionId: integer (int64)
  Title: Promotion ID

  The primary key of loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• PromotionName: string
  Read Only: true

  The name of the promotion corresponding to the promotionId attribute. There is no default value, dependency, or limitation associated with this attribute.
• QualPointFlag: boolean
  Title: Qualifying

  Maximum Length: 1

  Default Value: false

  The point type qualifying point attribute is a boolean attribute that indicates that the points accrued when the promotion gets applied count toward earning tier status, but cannot be redeemed for rewards. The default value is N. There is no dependency or limitation associated with this attribute.
• ReactivateFlag: boolean
  Title: Reactivate

  Maximum Length: 1

  Default Value: false

  The reactivate flag attribute reactivates members points after they have expired. The default value is N. There is no dependency or limitation associated with this attribute.
• ReadonlyFlag: boolean
  Title: Read Only

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the point type attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.
• RetEffFlag: boolean
  Maximum Length: 1

  Default Value: false

  The point type effective start date attribute indicates the date when the attribute can be used in promotions. There is no default value, dependency, or limitation associated with this attribute.
• RptExpPdUOMCode: string
  Maximum Length: 30

  The unit of measure (UOM) for the time period when the expired points can be reactivated. The accepted values are Years, Months, Days, and so on. For example, if the reactivation expiry period is one year then the UOM is Year and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.
• RptExpPeriodLength: number
  The time period when the expired points can be reactivated. For example, if the reactivation expiry period is one year, then the time period length is 1 and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.
• TierClassId: integer (int64)
  Title: Tier Class ID

  The primary attribute of the loyalty tier class, which indicates the class to which a specific tier belongs. There is no default value, dependency, or limitation associated with this attribute.
• TierClassName: string
  Read Only: true

  The attribute indicates the name of the tier class corresponding to tierClassId attribute. There is no default value, dependency, or limitation associated with this attribute.
• WeightFactor: number
  Title: Weight Factor

  The point type weight factor attribute is used to determine which promotion must be applied to the transaction, if multiple promotions qualify. There is no default value, dependency, or limitation associated with this attribute.
• WeightFactorNq: number
  Title: Weight Factor

  The weight factor non-qualifying attribute is used to determine whether to generate qualifying or non-qualifying points of each type when the weight factor attribute is specified. This attribute has a dependency on the Weight Factor attribute. There is no default value or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "WeightFactor":{
            "title":"Weight Factor",
            "type":"number",
            "description":"The point type weight factor attribute is used to determine which promotion must be applied to the transaction, if multiple promotions qualify. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the point type attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new point type attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionId":{
            "title":"Promotion ID",
            "type":"integer",
            "description":"The primary key of loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttrTypeCode":{
            "title":"Attribute Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The point type attribute type code. This attribute reflects the type of the attribute, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "AttrDefnId":{
            "title":"Attribute Definition ID",
            "type":"integer",
            "description":"The primary key value of the loyalty attribute definitions corresponding to attribute types such as pointType, Member, Transaction, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InternalName":{
            "title":"Internal Name",
            "maxLength":75,
            "type":"string",
            "description":"The point type attribute internal name. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":30,
            "type":"string",
            "description":"The option to select values from entities such as Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ExpiryBasisMeaning":{
            "type":"string",
            "description":"The basis for point type expiry. The accepted values are Account Activity (points expire if there is no activity of the type and in the period specified for the point type), Period (expires after a period of time), Fixed Day or Fixed Month (specify the day and month when points expire). There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "type":"integer",
            "description":"The currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PromotionName":{
            "type":"string",
            "description":"The name of the promotion corresponding to the promotionId attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataTypeMeaning":{
            "title":"Data Type Meaning",
            "type":"string",
            "description":"The data type meaning attribute indicates whether the attribute is a string, or a number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RptExpPeriodLength":{
            "type":"number",
            "description":"The time period when the expired points can be reactivated. For example, if the reactivation expiry period is one year, then the time period length is 1 and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "QualPointFlag":{
            "title":"Qualifying",
            "maxLength":1,
            "type":"boolean",
            "description":"The point type qualifying point attribute is a boolean attribute that indicates that the points accrued when the promotion gets applied count toward earning tier status, but cannot be redeemed for rewards. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MethodName":{
            "title":"Method Name",
            "maxLength":75,
            "type":"string",
            "description":"The method that is used in the calculation of the point type attribute value that can be used in a promotion criteria. For example, the ORA_CAL_METHOD_MONTH_NAME method returns the month name. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CostPERPoint":{
            "title":"Cost per Point",
            "type":"number",
            "description":"The cost for each point. If you want to allow the product to be redeemed for a combination of points and currency, then enter the amount of money assigned as the cash value of one point. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the point type attributes occur. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The loyalty user that created the promotion attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new promotion attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyExchDt":{
            "title":"Currency Exchange Date",
            "type":"string",
            "description":"The date when the point type attribute currency exchange takes place. This attribute displays the date of the currency exchange during the creation of the point type attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramName":{
            "type":"string",
            "description":"The program for which the point type is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the created point type attribute 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
        },
        "ReactivateFlag":{
            "title":"Reactivate",
            "maxLength":1,
            "type":"boolean",
            "description":"The reactivate flag attribute reactivates members points after they have expired. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PickFieldName":{
            "title":"Pick Field Name",
            "maxLength":75,
            "type":"string",
            "description":"The pick field name attribute is the user readable string of the attribute PickField. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpiryMonthCode":{
            "title":"Expiration Month Code",
            "maxLength":30,
            "type":"string",
            "description":"The expiry month attribute specifies the month when the points expire if the expiry basis is Month. This attribute is dependent on Expiry Basis Code. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "WeightFactorNq":{
            "title":"Weight Factor",
            "type":"number",
            "description":"The weight factor non-qualifying attribute is used to determine whether to generate qualifying or non-qualifying points of each type when the weight factor attribute is specified. This attribute has a dependency on the Weight Factor attribute. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ReadonlyFlag":{
            "title":"Read Only",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the point type attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PickList":{
            "title":"Pick List",
            "maxLength":75,
            "type":"string",
            "description":"The pick list attribute is enabled if the attribute is a field whose values are entered using a picklist. When defining criteria and actions, the picklist with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayFlag":{
            "title":"Display",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that indicates whether the point type attribute should be displayed or not, so that it can be used in the promotion criteria. The default value is Y. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "DataTypeCode":{
            "title":"Data Type",
            "maxLength":30,
            "type":"string",
            "description":"The point type attribute data type code indicates whether the attribute is a string, or number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "RptExpPdUOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure (UOM) for the time period when the expired points can be reactivated. The accepted values are Years, Months, Days, and so on. For example, if the reactivation expiry period is one year then the UOM is Year and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the point type attributes occur. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CancelActnCode":{
            "title":"Cancel Action Code",
            "maxLength":30,
            "type":"string",
            "description":"The specification of which action must be applied during a transaction cancellation. The accepted values are Leave As Is (if selected, the value of the attribute remains the same when a transaction is cancelled), Revert, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodUOMMeaning":{
            "type":"string",
            "description":"The point type period unit of measure. Period type options are Days, Months, Quarters, Years, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MergeActionCode":{
            "title":"Merge Action",
            "maxLength":30,
            "type":"string",
            "description":"The attribute merge action specifies how the program handles the attribute during a member merge. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PickField":{
            "title":"Pick Field",
            "maxLength":75,
            "type":"string",
            "description":"The pick field whose value the user sees in the UI after selecting from the pick applet. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultValue":{
            "title":"Default Value",
            "maxLength":75,
            "type":"string",
            "description":"The default value that is used when the attribute is created for a member for the first time. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumReactivationQuantity":{
            "title":"Minimum Reactivation Quantity",
            "type":"number",
            "description":"The minimum points required to reactivate the expired points so that they can be used for redemption. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DynamicFlag":{
            "title":"Dynamic",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that indicates whether the attribute value is calculated dynamically based on another attribute, which is used by the promotion criteria. The criteria can compare an attribute to a value or compare an attribute to another attribute. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The point types attribute display name that is displayed to the user. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "TierClassId":{
            "title":"Tier Class ID",
            "type":"integer",
            "description":"The primary attribute of the loyalty tier class, which indicates the class to which a specific tier belongs. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RetEffFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The point type effective start date attribute indicates the date when the attribute can be used in promotions. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "MonthsLength":{
            "title":"Months Length",
            "type":"number",
            "description":"The numeric value that corresponds to the number of months during which points will expire. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "TierClassName":{
            "type":"string",
            "description":"The attribute indicates the name of the tier class corresponding to tierClassId attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpiryBasisCode":{
            "title":"Expiry Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis code for point type expiry. The accepted values are ORA_PT_EX_ACC_ACT, ORA_PT_EX_PERIOD. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PickApplet":{
            "title":"Pick Applet",
            "maxLength":75,
            "type":"string",
            "description":"The point type pick applet attribute is a field whose values are entered using a dialog box. When defining criteria and actions, the dialog box with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PointActivityMeaning":{
            "type":"string",
            "description":"The point type activity options are Accrual, Redemption, or Accrual/Redemption. This field is activated only if the point expiry basis is account activity. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccntActCode":{
            "title":"Activity",
            "maxLength":30,
            "type":"string",
            "description":"The point type account activity code. If this option is specified, then points expire if there is no activity of the type within the period specified for the point type. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ExpiryAdjustmentMeaning":{
            "type":"string",
            "description":"The blocks of points having different expiration dates and sales prices that are created at the time of credit. When members accrue points, these point blocks are debited based on a pricing rule, with the earliest expiration dates debited first. These point blocks require adjustment if there are errors in crediting or debiting point balances. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExpiryDayCode":{
            "title":"Expiration Day Code",
            "maxLength":30,
            "type":"string",
            "description":"The expiry day attribute specifies the day of the month when the points expire if the expiry basis is Date. This attribute is dependent on Expiry Basis Code. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LoyAttrdefnBId":{
            "title":"Attribute Definition ID",
            "type":"integer",
            "description":"The primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PrgFormulaId":{
            "title":"Program Formula ID",
            "type":"integer",
            "description":"The program formula identifier that is available for use by a promotion, but only if it is associated with the same program as the program for the promotion. The formula can be used in criteria for comparisons and in actions for assigning values or updating attributes with the formula value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExpPeriodLen":{
            "title":"Period Quantity",
            "type":"integer",
            "description":"The expiry period length attribute is used to specify a length of time after when points expire. For example, if the points expire two years after they are earned, then the length is set to 2. After the points expire, the member can no longer exchange them for rewards. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The additional details that pertain to the point type. There is no default value, dependency associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "BusSvcName":{
            "title":"Business Service Name",
            "maxLength":75,
            "type":"string",
            "description":"The external business service that can be called in a promotion for the evaluation of business criteria. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the point type attribute is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the promotion attributes occur. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : loyPrograms-ProgramPartners-item-response

Type: object

Show Source

• AcrlValidPdLen: number
  The Accrual Validity Length specifies the period the accrual is valid, if precalculated accruals are enabled for a program. For example, if the period is six months, the length is 6. This attribute is dependent on the Pre-calculated Accrual Flag attribute. There is no default value or limitation associated with this attribute.
• AcrlValidUOMCode: string
  Maximum Length: 30

  The program partner accrual valid unit of measure (UOM) code. If Precalculated Accruals are enabled for a program, then Accrual Validity Length specifies the period that the accrual is valid. For example, if the period is six months, the UOM is Month. This attribute is dependent on Pre-calculated Accrual Flag attribute. There is no default value or limitation associated with this attribute.
• AllwNegativeFlag: boolean
  Maximum Length: 1

  The Allow Negative Flag boolean attribute, if enabled, allows transactions that result in the partner having a negative point balance. The default value is N. There is no dependency or limitation associated with this attribute.
• BillingType: string
  Title: Billing Type Meaning

  Read Only: true

  Maximum Length: 80

  The program partner billing type identifier specifies the type of billing for the member. There is no default value, dependency, or limitation associated with this attribute.
• BillingTypeCode: string
  Title: Billing Type

  Maximum Length: 30

  The program partner billing type code identifier specifies the type of billing for the member. The list of accepted values are Pre-paid (the partners buy point blocks before members earn the points where a point block representing the amount of points purchased is created and activated) and Post Paid (the partner pays for points only after the points have been given to members where the host company bills the partner after the points are used). There is no default value, dependency, or limitation associated with this attribute.
• ContactEmail: string
  Read Only: true

  The primary contact email address of the partner who is associated with the program. There is no default value, dependency, or limitation associated with this attribute.
• ContactPhone: string
  Read Only: true

  The primary contact phone number of the partner who is associated with the program. There is no default value, dependency, or limitation associated with this attribute.
• CreditLimit: number
  The program partner credit limit attribute specifies the maximum points allowed in the case of a negative point balance. There is no dependency or limitation associated with this attribute.
• EnableBillingFlag: boolean
  Title: Enable Partner Billing

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the partner billing is enabled for the partner or not. The default value is N. There is no dependency or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyProgOrgId: integer (int64)
  The organization identifier of the program partner. There is no default value, dependency, or limitation associated with this attribute.
• MinimumOrderQuantity: number
  The program partner minimum order quantity attribute specifies the minimum number of points in the automatically created point block. The default value is N. There is no default value, dependency, or limitation associated with this attribute.
• OrgExtensionId: integer (int64)
  The program partner organization expansion identifier, which is used to uniquely identify a partner. There is no default value, dependency, or limitation associated with this attribute.
• PartnerCompanyNumber: string
  Title: Partner Number

  Read Only: true

  Maximum Length: 30

  The partner company number of the associated partner. There is no default value, dependency, or limitation associated with this attribute.
• PartnerNumber: string
  Title: Partner Number

  Read Only: true

  Maximum Length: 30

  The partner number of the associated partner. There is no default value, dependency, or limitation associated with this attribute.
• PartnerTermsAttributes: array Partner Term Attributes
  Title: Partner Term Attributes

  The partner term attributes resource is used to retrieve the details of the partner terms defined for the partner.
• PartnerType: string
  The program partners partner type identifier specifies the partner type, that is, a prepaid partner or a post paid partner. There is no default value, dependency, or limitation associated with this attribute.
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true

  The primary key of loyalty partners. There is no default value, dependency, or limitation associated with this attribute.
• PartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The party name of the loyalty partner. This information shows the name of partner for a given Partner PartyNumber. There is no default value, dependency, or limitation associated with this attribute.
• PrecalcAcrlFlag: boolean
  Maximum Length: 1

  The program partner precalculated accrual attribute is a boolean attribute that specifies whether partners can precalculate the points to be credited to members and send them together with the accrual activity details. The default value is N. There is no dependency or limitation associated with this attribute.
• PricingRuleId: integer (int64)
  The program partner pricing rule identifier specifies the pricing rule that is used to determine the price of the point block. There is no default value, dependency, or limitation associated with this attribute.
• ProgramName: string
  Read Only: true

  The program for which the promotion is created. There is no default value, dependency, or limitation associated with this attribute.
• ReorderLimit: number
  The program partner reorder limit identifier specifies the number of points that triggers reordering. For example, if you enter 10,000, a new block is automatically created when the existing block for this partner is less than or equal to 10,000 points remaining. There is no default value, dependency, or limitation associated with this attribute.
• RetBeforeDays: number
  The specification of the amount of time after point expiration where the points can be reactivated. There is no default value, dependency, or limitation associated with this attribute.
• SkipAcrlValFlag: boolean
  Maximum Length: 1

  The skip accrual value boolean attribute, if enabled, skips any validations pertaining to accruals. For example, Precalculated Accrual allows the set up of a limit on the points that a partner can send in a single transaction in a defined time period. If this flag is enabled, then points can be credited directly to the member???s account without further validation by the host organization. The default value is N. There is no dependency or limitation associated with this attribute.
• ValdtDisputeUsr: string
  Maximum Length: 30

  The accrual dispute transactions (Missing or Incorrect Accrual Dispute) that are created and that are submitted to the partner user for validation. Whether or not all accrual disputes are sent to the partner for validation depends on the loyalty terms set up for that partner. There is no default value, dependency, or limitation associated with this attribute.
• ValidDisputeFlag: boolean
  Maximum Length: 1

  The valid dispute boolean attribute, if enabled, validates the disputed transactions. The default value is N. There is no dependency or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "PartnerType":{
            "type":"string",
            "description":"The program partners partner type identifier specifies the partner type, that is, a prepaid partner or a post paid partner. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "OrgExtensionId":{
            "type":"integer",
            "description":"The program partner organization expansion identifier, which is used to uniquely identify a partner. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AcrlValidUOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"The program partner accrual valid unit of measure (UOM) code. If Precalculated Accruals are enabled for a program, then Accrual Validity Length specifies the period that the accrual is valid. For example, if the period is six months, the UOM is Month. This attribute is dependent on Pre-calculated Accrual Flag attribute. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PrecalcAcrlFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The program partner precalculated accrual attribute is a boolean attribute that specifies whether partners can precalculate the points to be credited to members and send them together with the accrual activity details. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ReorderLimit":{
            "type":"number",
            "description":"The program partner reorder limit identifier specifies the number of points that triggers reordering. For example, if you enter 10,000, a new block is automatically created when the existing block for this partner is less than or equal to 10,000 points remaining. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidDisputeFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The valid dispute boolean attribute, if enabled, validates the disputed transactions. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The party name of the loyalty partner. This information shows the name of partner for a given Partner PartyNumber. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPhone":{
            "type":"string",
            "description":"The primary contact phone number of the partner who is associated with the program. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerTermsAttributes":{
            "title":"Partner Term Attributes",
            "type":"array",
            "description":"The partner term attributes resource is used to retrieve the details of the partner terms defined for the partner.",
            "items":{
                "$ref":"#/components/schemas/loyPrograms-ProgramPartners-PartnerTermsAttributes-item-response"
            }
        },
        "AcrlValidPdLen":{
            "type":"number",
            "description":"The Accrual Validity Length specifies the period the accrual is valid, if precalculated accruals are enabled for a program. For example, if the period is six months, the length is 6. This attribute is dependent on the Pre-calculated Accrual Flag attribute. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ValdtDisputeUsr":{
            "maxLength":30,
            "type":"string",
            "description":"The accrual dispute transactions (Missing or Incorrect Accrual Dispute) that are created and that are submitted to the partner user for validation. Whether or not all accrual disputes are sent to the partner for validation depends on the loyalty terms set up for that partner. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllwNegativeFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The Allow Negative Flag boolean attribute, if enabled, allows transactions that result in the partner having a negative point balance. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "BillingType":{
            "title":"Billing Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The program partner billing type identifier specifies the type of billing for the member. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "LoyProgOrgId":{
            "type":"integer",
            "description":"The organization identifier of the program partner. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EnableBillingFlag":{
            "title":"Enable Partner Billing",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the partner billing is enabled for the partner or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "CreditLimit":{
            "type":"number",
            "description":"The program partner credit limit attribute specifies the maximum points allowed in the case of a negative point balance. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingTypeCode":{
            "title":"Billing Type",
            "maxLength":30,
            "type":"string",
            "description":"The program partner billing type code identifier specifies the type of billing for the member. The list of accepted values are Pre-paid (the partners buy point blocks before members earn the points where a point block representing the amount of points purchased is created and activated) and Post Paid (the partner pays for points only after the points have been given to members where the host company bills the partner after the points are used). There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProgramName":{
            "type":"string",
            "description":"The program for which the promotion is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerNumber":{
            "title":"Partner Number",
            "maxLength":30,
            "type":"string",
            "description":"The partner number of the associated partner. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The primary key of loyalty partners. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RetBeforeDays":{
            "type":"number",
            "description":"The specification of the amount of time after point expiration where the points can be reactivated. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactEmail":{
            "type":"string",
            "description":"The primary contact email address of the partner who is associated with the program. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumOrderQuantity":{
            "type":"number",
            "description":"The program partner minimum order quantity attribute specifies the minimum number of points in the automatically created point block. The default value is N. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PricingRuleId":{
            "type":"integer",
            "description":"The program partner pricing rule identifier specifies the pricing rule that is used to determine the price of the point block. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartnerCompanyNumber":{
            "title":"Partner Number",
            "maxLength":30,
            "type":"string",
            "description":"The partner company number of the associated partner. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "SkipAcrlValFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The skip accrual value boolean attribute, if enabled, skips any validations pertaining to accruals. For example, Precalculated Accrual allows the set up of a limit on the points that a partner can send in a single transaction in a defined time period. If this flag is enabled, then points can be credited directly to the member???s account without further validation by the host organization. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Partner Term Attributes

Type: array

Title: Partner Term Attributes

The partner term attributes resource is used to retrieve the details of the partner terms defined for the partner.

Show Source

• Array of: object loyPrograms-ProgramPartners-PartnerTermsAttributes-item-response

{
    "title":"Partner Term Attributes",
    "type":"array",
    "description":"The partner term attributes resource is used to retrieve the details of the partner terms defined for the partner.",
    "items":{
        "$ref":"#/components/schemas/loyPrograms-ProgramPartners-PartnerTermsAttributes-item-response"
    }
}

Nested Schema : loyPrograms-ProgramPartners-PartnerTermsAttributes-item-response

Type: object

Show Source

• ConvRate: number
  Title: Conversion Rate

  The conversion rate defined for the partner in the partner term attribute. There is no default value, dependency, or limitation associated with this attribute.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The loyalty user that created the partner term attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new partner term attribute. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Read Only: true

  The date when the partner term attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new partner term attribute record. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the partner term attribute record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the partner term attribute record occur. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that last updated the partner term attribute. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the partner term attribute. There is no dependency or limitation associated with this attribute.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login details of the user that last logged in. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the partner term attribute. There is no dependency or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PointTypeId: integer (int64)
  Title: Point Type

  The point type identifier, which uniquely identifies each point type. Various point types are defined to reward and recognize members based on their activities, such as, completing a flight or referring a friend to the program. Some point types are defined to allow members to redeem points for a product or service, while some are defined to track their behavior and reward them by assigning a new tier status. There is no default value, dependency, or limitation associated with this attribute.
• PointTypeName: string
  The name of the point type. This is also a parameter in the redemptionProductsFinder finder. If the value is not provided, this attribute lists ProdRedemptionPoint for all possible point types in a given program name. There is no dependency or limitation associated with this attribute.
• ProgPartnerId: integer (int64)
  The partner identifier. There is no default value, dependency, or limitation associated with this attribute.
• ProgPartnerPnttypeId: integer (int64)
  The partner point type detail from the partner term attribute for the partner. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the partner term attribute. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the partner term attribute. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the partner term attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new partner term attribute record. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The loyalty user that created the partner term attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new partner term attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProgPartnerId":{
            "type":"integer",
            "description":"The partner identifier. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ConvRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"The conversion rate defined for the partner in the partner term attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PointTypeName":{
            "type":"string",
            "description":"The name of the point type. This is also a parameter in the redemptionProductsFinder finder. If the value is not provided, this attribute lists ProdRedemptionPoint for all possible point types in a given program name. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "ProgPartnerPnttypeId":{
            "type":"integer",
            "description":"The partner point type detail from the partner term attribute for the partner. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the partner term attribute record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the partner term attribute record occur. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last logged in. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the partner term attribute. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PointTypeId":{
            "title":"Point Type",
            "type":"integer",
            "description":"The point type identifier, which uniquely identifies each point type. Various point types are defined to reward and recognize members based on their activities, such as, completing a flight or referring a friend to the program. Some point types are defined to allow members to redeem points for a product or service, while some are defined to track their behavior and reward them by assigning a new tier status. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : loyPrograms-RedemptionProducts-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The loyalty user that created the redemption product. Oracle Loyalty Cloud generates this attribute value during the creation of a new redemption product record. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the redemption product is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new redemption product record. There is no default value, dependency, or limitation associated with this attribute.
• InternalName: string
  Title: Internal Name

  Read Only: true

  Maximum Length: 75

  The redemption product internal name. The identifier internal name values come from the loyalty attributes definitions. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.
• ItemNumber: string
  Title: Product Number

  Read Only: true

  Maximum Length: 300

  The item number of the loyalty product. This is the product number for which the redemption points are shown. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the redemption product record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the redemption product record occur. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user that last updated the redemption product. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the redemption product. There is no dependency or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberPointBalance: number
  The member's point balance for a given point type. This value shows the Member Check Credit functionality when the MemberNumber parameter is used in the redemptionProductsFinder finder to find the redemption points for each product, and also shows the point balance of the member as a credit check.
• PartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The party name of the loyalty partner. This information shows the name of partner for a given Partner PartyNumber. There is no default value, dependency, or limitation associated with this attribute.
• PartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  The party number of the loyalty partner. PartyNumber is also a parameter in the redemptionProductsFinder finder. There is no default value, dependency, or limitation associated with this attribute.
• PointTypeName: string
  Title: Point Type Name

  The name of the point type. This is also a parameter in the redemptionProductsFinder finder. If the value not provided, this attribute lists ProdRedemptionPoint for all possible point types in a given ProgramName. There is no default value or limitation associated with this attribute.
• ProdRedempComments: string
  Title: Comments

  Maximum Length: 1000

  The text field indicates the comments added by the loyalty administrator in a redemption product record. There is no default value, dependency, or limitation associated with this attribute.
• ProdRedempEndDt: string (date)
  Title: End Date

  The end date for the loyalty product redemption. It is the TransactionDate parameter in the redemptionProductsFinder finder search in between ProdRedempStartDt and ProdProdRedempEndDt. There is no default value, dependency, or limitation associated with this attribute.
• ProdRedempStartDt: string (date)
  Title: Start Date

  The start date for loyalty product redemption. This is the starting date when the Redemption Product is effective. It is the TransactionDate parameter in redemptionProductsFinder finder search in between ProdRedempStartDt and ProdProdRedempEndDt. There is no default value, dependency, or limitation associated with this attribute.
• ProdRedemptionPoint: integer (int32)
  Title: Points

  The points required to redeem the loyalty product. Each product requires some point value which indicates the points required while redeeming the product. There is no default value, dependency, or limitation associated with this attribute.
• ProdRedempURL: string
  Title: Product Redemption URL

  Maximum Length: 1000

  The text field indicates the redemption URL for a product which is enabled for redemption. There is no default value, dependency, or limitation associated with this attribute.
• ProductName: string
  Title: Product

  The loyalty product name. This attribute describes the product for a given ItemNumber filter parameter in the redemptionProductsFinder finder and is the product for which the ProdRedemptionPoint value is shown.
• ProgramName: string
  Title: Program

  Read Only: true

  Maximum Length: 50

  The program for which the promotion is created. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the redemption product. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the redemption product. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the redemption product is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new redemption product record. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "ProdRedempEndDt":{
            "title":"End Date",
            "type":"string",
            "description":"The end date for the loyalty product redemption. It is the TransactionDate parameter in the redemptionProductsFinder finder search in between ProdRedempStartDt and ProdProdRedempEndDt. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The loyalty user that created the redemption product. Oracle Loyalty Cloud generates this attribute value during the creation of a new redemption product record. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "ProductName":{
            "title":"Product",
            "type":"string",
            "description":"The loyalty product name. This attribute describes the product for a given ItemNumber filter parameter in the redemptionProductsFinder finder and is the product for which the ProdRedemptionPoint value is shown.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ProdRedemptionPoint":{
            "title":"Points",
            "type":"integer",
            "description":"The points required to redeem the loyalty product. Each product requires some point value which indicates the points required while redeeming the product. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ProdRedempURL":{
            "title":"Product Redemption URL",
            "maxLength":1000,
            "type":"string",
            "description":"The text field indicates the redemption URL for a product which is enabled for redemption. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The party name of the loyalty partner. This information shows the name of partner for a given Partner PartyNumber. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PointTypeName":{
            "title":"Point Type Name",
            "type":"string",
            "description":"The name of the point type. This is also a parameter in the redemptionProductsFinder finder. If the value not provided, this attribute lists ProdRedemptionPoint for all possible point types in a given ProgramName. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "InternalName":{
            "title":"Internal Name",
            "maxLength":75,
            "type":"string",
            "description":"The redemption product internal name. The identifier internal name values come from the loyalty attributes definitions. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Program",
            "maxLength":50,
            "type":"string",
            "description":"The program for which the promotion is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberPointBalance":{
            "type":"number",
            "description":"The member's point balance for a given point type. This value shows the Member Check Credit functionality when the MemberNumber parameter is used in the redemptionProductsFinder finder to find the redemption points for each product, and also shows the point balance of the member as a credit check.",
            "nullable":true,
            "x-queryable":true
        },
        "ProdRedempComments":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "description":"The text field indicates the comments added by the loyalty administrator in a redemption product record. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The party number of the loyalty partner. PartyNumber is also a parameter in the redemptionProductsFinder finder. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Product Number",
            "maxLength":300,
            "type":"string",
            "description":"The item number of the loyalty product. This is the product number for which the redemption points are shown. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProdRedempStartDt":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date for loyalty product redemption. This is the starting date when the Redemption Product is effective. It is the TransactionDate parameter in redemptionProductsFinder finder search in between ProdRedempStartDt and ProdProdRedempEndDt. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the redemption product record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the redemption product record occur. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : loyPrograms-TierClasses-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  The boolean attribute that identifies whether the tier class is currently active or not. The default value is N. There is no dependency or limitation associated with this attribute.
• ApplyFlag: boolean
  Title: Tier Class Applied

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the tier class is applied to existing members. The default value is N. There is no dependency or limitation associated with this attribute.
• ApproverId: integer (int64)
  Title: Approver ID

  The user that approves tier downgrades. There is no dependency or limitation associated with this attribute.
• AssessDateCode: string
  Title: Assessment Day

  Maximum Length: 30

  Default Value: 1

  The tier assess date code specifies the day to schedule a tier assessment for a tier class. There is no default value, dependency, or limitation associated with this attribute.
• AssessMonth: string
  Title: Assessment Month

  Maximum Length: 30

  Default Value: 1

  The tier assess month identifier specifies the month to schedule a tier assessment for a tier class. There is no default value, dependency, or limitation associated with this attribute.
• AssessRecur: string
  Title: Recurring Period Meaning

  Read Only: true

  Maximum Length: 80

  The tier assess recurring attribute specifies how frequently the tier assessment schedule is repeated. Assessment recurrence period options are Monthly and Yearly. There is no default value, dependency, or limitation associated with this attribute.
• AssessRecurCode: string
  Title: Recurring Period

  Maximum Length: 30

  Default Value: ORA_TR_LEN_UOM_YEAR

  The tier assess recurring code specifies how frequently the tier assessment schedule is repeated. Assessment recurrence period options are Monthly and Yearly. There is no default value, dependency, or limitation associated with this attribute.
• CardType: string
  Title: Card Type Meaning

  Read Only: true

  Maximum Length: 80

  The attribute indicates the member card type associated with a tier under a tier class. There is no default value, dependency, nor limitation associated with this attribute.
• CardTypeCode: string
  Title: Card Type Code

  Read Only: true

  Maximum Length: 30

  The attribute indicates the member card type associated with a tier under a tier class. There is no default value, dependency, nor limitation associated with this attribute.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user that created the tier class. Oracle Loyalty Cloud generates this attribute value during the creation of a new tier class. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the tier class is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new tier class. There is no default value, dependency, or limitation associated with this attribute.
• EndTierlenUOMCode: string
  Title: End Tier Length Unit of Measure

  Maximum Length: 30

  The tier end date is calculated using the value of the Minimum Tier Length and Minimum Tier Length Period parameters. The minimum period specifies the time that a member is guaranteed membership in any tier within the tier class. For example, if the minimum period is six months, then length is 6, and Period UOM is Month. There is no default value or limitation associated with this attribute.
• EndTierMthDyCode: string
  Title: End Tier Period Month

  Maximum Length: 30

  The end tier month day code attribute specifies the day of the month when the tier period month ends. There is no default value, dependency, or limitation associated with this attribute.
• EndTierPdDayCode: string
  Title: End Tier Period Day

  Maximum Length: 30

  The end tier period day code attribute specifies the day when the tier period ends. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the tier class record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the tier class occur. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user that last updated the tier class. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the tier class occur. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user that last updated the tier class. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the tier class occur. There is no default value, dependency, or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyTierClsId: integer (int64)
  Title: Loyalty Tier Class ID

  The primary key of the loyalty tier class. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• MinimumTierLength: integer (int32)
  Title: Minimum Tier Length in Months

  The minimum period of time that a member is guaranteed membership in any tier within this tier class. For example, if the minimum period is six months, then length is 6 and Period is Month. There is no default value, dependency, or limitation associated with this attribute.
• PrimaryTierName: string
  Title: Primary Tier

  Maximum Length: 30

  The attribute indicates the name of primary tier of a tier class. A tier class can have only one primary tier class. There is no default value, dependency, nor limitation associated with this attribute.
• PrTierId: integer (int64)
  Title: Primary Tier ID

  The primary tier identifier is the lowest tier of the tier class and is the tier where members are first enrolled. This value can only be specified after the tiers have been created for this class, and it must be specified before activating the tier class. There is no default value, dependency, or limitation associated with this attribute.
• QualifyingPoints: integer (int64)
  Title: Qualifying Points

  Read Only: true

  The attribute indicates the minimum number of points required to qualify a tier. There is no dependency or limitation associated with this attribute.
• QualPeriodLength: integer (int32)
  Title: Qualifying Period Length in Months

  The qualifying period length specifies the length for the initial qualifying period for the tier. For example, if the qualifying period is one year, the period length is 1. It is recommended that the Quality Period Length be defined at the Tier Class level. However, if the Quality Period Length is defined at Tier level, then the tier level definition takes precedence. There is no default value, dependency, or limitation associated with this attribute.
• QualPeriodUOMCode: string
  Title: Qualifying Period Unit of Measure

  Maximum Length: 30

  The qualifying period unit of measure (UOM) code specifies the UOM for the initial qualifying period for the tier. For example, if the qualifying period is one year, then UOM is Year. There is no default value, dependency, or limitation associated with this attribute.
• QualPointTypeId: integer (int64)
  Title: Qualifying Point Type

  The unique identifier of the qualifying point type of a tier class. There is no dependency or limitation associated with this attribute.
• RequalPdUOMCode: string
  Title: Requalifying Period Unit of Measure

  Maximum Length: 30

  The requalifying period unit of measure (UOM) code specifies the UOM for the qualifying period for existing members to remain in this tier. Usually, this period is the same as the initial qualifying period. There is no default value, dependency, or limitation associated with this attribute.
• RequalPeriodLength: number
  Title: Requalifying Period Length

  The requalifying period length identifier specifies the length for the qualifying period for existing members to remain in the same tier. Usually, the period is same as the initial qualifying period. There is no default value, dependency, or limitation associated with this attribute.
• RestartQualPeriodCode: string
  Title: Restart Qualifying Period

  Maximum Length: 30

  The restart qualifying period specifies the length of time for the new qualifying period that starts after a tier status change. Possible options are Qualifying Period Expiration (the length of time after the new qualifying period starts at the expiration of the current qualifying period) or Tier Status Change (the length of time for the new qualifying period to start, immediately when the tier changes). There is no default value, dependency, or limitation associated with this attribute.
• SequenceNumber: number
  Title: Sequence Number

  Read Only: true

  The unique sequence number of the corresponding tier of a tier class. There is no dependency or limitation associated with this attribute.
• Snapto: string
  Title: Tier End Date Snapped to Meaning

  Read Only: true

  Maximum Length: 80

  The attribute indicates the date of the tier end that should map with for the member's tier record. Possible values in this are 1st day of Month, 1st day of Quarter, 1st day of year, or a calculated date.
• SnaptoCode: string
  Title: Tier End Date Snapped To

  Maximum Length: 30

  Default Value: ORA_EXP_ADJ_CALC_DATE

  This attribute indicates the date of the tier end that should map with for the member's tier record. Possible values in this are 1st day of Month, 1st day of Quarter, 1st day of year or calculated date.
• StartQualPeriod: string
  Title: Tier Assessment Model Meaning

  Read Only: true

  Maximum Length: 80

  The restart qualifying period specifies the length of time for the new qualifying period that starts after a tier status change. Possible options are Qualifying Period Expiration (the length of time after the new qualifying period starts at the expiration of the current qualifying period) or Tier Status Change (the length of time for the new qualifying period to start, immediately when the tier changes). There is no default value, dependency, or limitation associated with this attribute.
• StartQualPeriodCode: string
  Title: Tier Assessment Model

  Maximum Length: 30

  Default Value: ORA_TR_MODEL_NONE

  The start qualifying period code specifies when the qualifying period starts. The option determines the tier assessment model. The possible options are Enrollment Date/Anniversary Date, First Day of Month, Fixed Date, and Rolling. There is no default value, dependency, or limitation associated with this attribute.
• STQualPeriodDay: integer (int32)
  Title: Start Qualifying Period Day

  This attribute indicates tier qualifying period start day. There is no dependency or limitation associated with this attribute.
• STQualPeriodDayCode: string
  Title: Start Qualifying Period Day

  Maximum Length: 30

  The start qualifying period day code specifies the day from when the qualifying period starts. The option determines the tier assessment model. The possible options are Enrollment Date/Anniversary Date, First Day of Month, Fixed Date, and Rolling. There is no default value, dependency, or limitation associated with this attribute.
• STQualPeriodMonthCode: string
  Title: Start Qualifying Period Month

  Maximum Length: 30

  The start qualifying period month code specifies the month from when the qualifying period starts. The option determines the tier assessment model. The possible options are: Enrollment Date/Anniversary Date, First Day of Month, Fixed Date, Rolling. There is no default value, dependency, or limitation associated with this attribute.
• STTierPeriodDay: integer (int32)
  Title: Start Tier Period Day

  This attribute indicates tier period start day. There is no dependency or limitation associated with this attribute.
• STTierPeriodDayCode: string
  Title: Start Tier Period Day

  Maximum Length: 30

  The start tier period day specifies the day from when the tier period starts. The possible options of Start Tier Period are Enrollment/Anniversary Date or Fixed date. There is no default value, dependency, or limitation associated with this attribute.
• STTierPeriodMonthCode: string
  Title: Start Tier Period Month

  Maximum Length: 30

  The start tier period month specifies the month from when the tier period month starts. Possible options of Start Tier Period are Enrollment/Anniversary Date or Fixed date. There is no default value, dependency, or limitation associated with this attribute.
• TierClassName: string
  Title: Tier Class Name

  Maximum Length: 30

  The attribute is a unique identifier that indicates the name of the tier class. There is no default value, dependency, or limitation associated with this attribute.
• TierId: integer (int64)
  Title: Loyalty Tier ID

  Read Only: true

  The primary key of loyalty tiers corresponding to a tier class. There is no dependency or limitation associated with this attribute.
• TierName: string
  Title: Tier Name

  Read Only: true

  Maximum Length: 30

  The name of tier defined under the tier class. There is no default value, dependency, or limitation associated with this attribute.
• TierPeriodLength: integer (int32)
  Title: Tier Period Length in Months

  This attribute indicates tier period length. There is no dependency or limitation associated with this attribute.
• TypeCode: string
  Title: Type Code

  Maximum Length: 30

  The type code attribute previously specified the tier class type in a multiple tier class scenario. Oracle Loyalty Cloud does not currently use this attribute. There is no default value, dependency, nor limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the tier class is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new tier class. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "STQualPeriodDay":{
            "title":"Start Qualifying Period Day",
            "type":"integer",
            "description":"This attribute indicates tier qualifying period start day. There is no dependency or limitation associated with this attribute.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "AssessDateCode":{
            "title":"Assessment Day",
            "maxLength":30,
            "type":"string",
            "description":"The tier assess date code specifies the day to schedule a tier assessment for a tier class. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SnaptoCode":{
            "title":"Tier End Date Snapped To",
            "maxLength":30,
            "type":"string",
            "description":"This attribute indicates the date of the tier end that should map with for the member's tier record. Possible values in this are 1st day of Month, 1st day of Quarter, 1st day of year or calculated date.",
            "nullable":true,
            "default":"ORA_EXP_ADJ_CALC_DATE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssessRecur":{
            "title":"Recurring Period Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The tier assess recurring attribute specifies how frequently the tier assessment schedule is repeated. Assessment recurrence period options are Monthly and Yearly. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "AssessRecurCode":{
            "title":"Recurring Period",
            "maxLength":30,
            "type":"string",
            "description":"The tier assess recurring code specifies how frequently the tier assessment schedule is repeated. Assessment recurrence period options are Monthly and Yearly. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "default":"ORA_TR_LEN_UOM_YEAR",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RequalPeriodLength":{
            "title":"Requalifying Period Length",
            "type":"number",
            "description":"The requalifying period length identifier specifies the length for the qualifying period for existing members to remain in the same tier. Usually, the period is same as the initial qualifying period. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "RestartQualPeriodCode":{
            "title":"Restart Qualifying Period",
            "maxLength":30,
            "type":"string",
            "description":"The restart qualifying period specifies the length of time for the new qualifying period that starts after a tier status change. Possible options are Qualifying Period Expiration (the length of time after the new qualifying period starts at the expiration of the current qualifying period) or Tier Status Change (the length of time for the new qualifying period to start, immediately when the tier changes). There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "EndTierPdDayCode":{
            "title":"End Tier Period Day",
            "maxLength":30,
            "type":"string",
            "description":"The end tier period day code attribute specifies the day when the tier period ends. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CardTypeCode":{
            "title":"Card Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The attribute indicates the member card type associated with a tier under a tier class. There is no default value, dependency, nor limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryTierName":{
            "title":"Primary Tier",
            "maxLength":30,
            "type":"string",
            "description":"The attribute indicates the name of primary tier of a tier class. A tier class can have only one primary tier class. There is no default value, dependency, nor limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartQualPeriod":{
            "title":"Tier Assessment Model Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The restart qualifying period specifies the length of time for the new qualifying period that starts after a tier status change. Possible options are Qualifying Period Expiration (the length of time after the new qualifying period starts at the expiration of the current qualifying period) or Tier Status Change (the length of time for the new qualifying period to start, immediately when the tier changes). There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "QualPeriodLength":{
            "title":"Qualifying Period Length in Months",
            "type":"integer",
            "description":"The qualifying period length specifies the length for the initial qualifying period for the tier. For example, if the qualifying period is one year, the period length is 1. It is recommended that the Quality Period Length be defined at the Tier Class level. However, if the Quality Period Length is defined at Tier level, then the tier level definition takes precedence. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "STTierPeriodMonthCode":{
            "title":"Start Tier Period Month",
            "maxLength":30,
            "type":"string",
            "description":"The start tier period month specifies the month from when the tier period month starts. Possible options of Start Tier Period are Enrollment/Anniversary Date or Fixed date. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "STTierPeriodDay":{
            "title":"Start Tier Period Day",
            "type":"integer",
            "description":"This attribute indicates tier period start day. There is no dependency or limitation associated with this attribute.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "TierPeriodLength":{
            "title":"Tier Period Length in Months",
            "type":"integer",
            "description":"This attribute indicates tier period length. There is no dependency or limitation associated with this attribute.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CardType":{
            "title":"Card Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The attribute indicates the member card type associated with a tier under a tier class. There is no default value, dependency, nor limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"number",
            "description":"The unique sequence number of the corresponding tier of a tier class. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApproverId":{
            "title":"Approver ID",
            "type":"integer",
            "description":"The user that approves tier downgrades. There is no dependency or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EndTierMthDyCode":{
            "title":"End Tier Period Month",
            "maxLength":30,
            "type":"string",
            "description":"The end tier month day code attribute specifies the day of the month when the tier period month ends. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "STQualPeriodMonthCode":{
            "title":"Start Qualifying Period Month",
            "maxLength":30,
            "type":"string",
            "description":"The start qualifying period month code specifies the month from when the qualifying period starts. The option determines the tier assessment model. The possible options are: Enrollment Date/Anniversary Date, First Day of Month, Fixed Date, Rolling. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "STTierPeriodDayCode":{
            "title":"Start Tier Period Day",
            "maxLength":30,
            "type":"string",
            "description":"The start tier period day specifies the day from when the tier period starts. The possible options of Start Tier Period are Enrollment/Anniversary Date or Fixed date. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the tier class. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the tier class occur. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LoyTierClsId":{
            "title":"Loyalty Tier Class ID",
            "type":"integer",
            "description":"The primary key of the loyalty tier class. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AssessMonth":{
            "title":"Assessment Month",
            "maxLength":30,
            "type":"string",
            "description":"The tier assess month identifier specifies the month to schedule a tier assessment for a tier class. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RequalPdUOMCode":{
            "title":"Requalifying Period Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"The requalifying period unit of measure (UOM) code specifies the UOM for the qualifying period for existing members to remain in this tier. Usually, this period is the same as the initial qualifying period. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user that created the tier class. Oracle Loyalty Cloud generates this attribute value during the creation of a new tier class. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TierClassName":{
            "title":"Tier Class Name",
            "maxLength":30,
            "type":"string",
            "description":"The attribute is a unique identifier that indicates the name of the tier class. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type code attribute previously specified the tier class type in a multiple tier class scenario. Oracle Loyalty Cloud does not currently use this attribute. There is no default value, dependency, nor limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplyFlag":{
            "title":"Tier Class Applied",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the tier class is applied to existing members. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "STQualPeriodDayCode":{
            "title":"Start Qualifying Period Day",
            "maxLength":30,
            "type":"string",
            "description":"The start qualifying period day code specifies the day from when the qualifying period starts. The option determines the tier assessment model. The possible options are Enrollment Date/Anniversary Date, First Day of Month, Fixed Date, and Rolling. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "QualPeriodUOMCode":{
            "title":"Qualifying Period Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"The qualifying period unit of measure (UOM) code specifies the UOM for the initial qualifying period for the tier. For example, if the qualifying period is one year, then UOM is Year. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that identifies whether the tier class is currently active or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PrTierId":{
            "title":"Primary Tier ID",
            "type":"integer",
            "description":"The primary tier identifier is the lowest tier of the tier class and is the tier where members are first enrolled. This value can only be specified after the tiers have been created for this class, and it must be specified before activating the tier class. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QualifyingPoints":{
            "title":"Qualifying Points",
            "type":"integer",
            "description":"The attribute indicates the minimum number of points required to qualify a tier. There is no dependency or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":22
            },
            "x-queryable":true
        },
        "TierId":{
            "title":"Loyalty Tier ID",
            "type":"integer",
            "description":"The primary key of loyalty tiers corresponding to a tier class. There is no dependency or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MinimumTierLength":{
            "title":"Minimum Tier Length in Months",
            "type":"integer",
            "description":"The minimum period of time that a member is guaranteed membership in any tier within this tier class. For example, if the minimum period is six months, then length is 6 and Period is Month. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TierName":{
            "title":"Tier Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of tier defined under the tier class. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Snapto":{
            "title":"Tier End Date Snapped to Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The attribute indicates the date of the tier end that should map with for the member's tier record. Possible values in this are 1st day of Month, 1st day of Quarter, 1st day of year, or a calculated date.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "StartQualPeriodCode":{
            "title":"Tier Assessment Model",
            "maxLength":30,
            "type":"string",
            "description":"The start qualifying period code specifies when the qualifying period starts. The option determines the tier assessment model. The possible options are Enrollment Date/Anniversary Date, First Day of Month, Fixed Date, and Rolling. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "default":"ORA_TR_MODEL_NONE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "QualPointTypeId":{
            "title":"Qualifying Point Type",
            "type":"integer",
            "description":"The unique identifier of the qualifying point type of a tier class. There is no dependency or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the tier class record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the tier class occur. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last updated the tier class. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the tier class occur. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndTierlenUOMCode":{
            "title":"End Tier Length Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"The tier end date is calculated using the value of the Minimum Tier Length and Minimum Tier Length Period parameters. The minimum period specifies the time that a member is guaranteed membership in any tier within the tier class. For example, if the minimum period is six months, then length is 6, and Period UOM is Month. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : loyPrograms-TransactionAttributes-item-response

Type: object

Show Source

• AccntActCode: string
  Title: Account Activity

  Maximum Length: 30

  The transaction attribute account activity code. If this option is specified, points expire if there is no activity of the type within the period specified for the point type. There is no default value, dependency, or limitation associated with this attribute.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the created transaction attribute is enabled for use or not. The default value is N. There is no dependency or limitation associated with this attribute.
• AttrDefnId: integer (int64)
  Title: Attribute Definition ID

  The primary key value of the loyalty attribute definitions corresponding to attribute types like pointType, Member, Transaction, and so on. There is no default value, dependency, or limitation associated with this attribute.
• AttrTypeCode: string
  Title: Attribute Type Code

  Maximum Length: 30

  Default Value: Field

  The transaction attribute type code. This attribute reflects the type of attribute, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.
• BusSvcName: string
  Title: Business Service Name

  Maximum Length: 75

  The external business service that can be called in the promotion to evaluate the business criteria. There is no default value, dependency, or limitation associated with this attribute.
• CancelActnCode: string
  Title: Cancel Action Code

  Maximum Length: 30

  The specification of the action that must be applied during a transaction cancellation. The accepted values are Leave As Is (if selected, the value of the attribute remains the same when a transaction is cancelled), Revert, and so on. There is no default value, dependency, or limitation associated with this attribute.
• CostperPoint: number
  The cost for each point. If you want to allow the product to be redeemed for a combination of points and currency, then enter the amount of money assigned as the cash value of one point. There is no default value, dependency, or limitation associated with this attribute.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The loyalty user that created the transaction attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new transaction attribute. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the transaction attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new transaction attribute. There is no default value, dependency, or limitation associated with this attribute.
• CurrencyCode: integer (int64)
  Title: Currency

  The currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value, dependency, or limitation associated with this attribute.
• CurrencyExchDt: string (date)
  Title: Currency Exchange Date

  The date when the transaction attribute currency exchange takes place. This attribute displays the date of the currency exchange during transaction attributes creation. There is no default value, dependency, or limitation associated with this attribute.
• DataType: string
  Title: Data Type Meaning

  Read Only: true

  Maximum Length: 80

  The transaction attribute data type indicates whether the attribute is a string, or a number, and so on. During a transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value or limitation associated with this attribute.
• DataTypeCode: string
  Title: Data Type

  Maximum Length: 30

  The promotion attribute data type name indicates whether the attribute is a string, or number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.
• DefaultVal: string
  Title: Default Value

  Maximum Length: 75

  The cost for each point. If you want to allow the product to be redeemed for a combination of points and currency, then enter the amount of money assigned as the cash value of one point. There is no default value, dependency, or limitation associated with this attribute.
• DescriptionText: string
  Title: Description

  Maximum Length: 1000

  The currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value, dependency, or limitation associated with this attribute.
• DisplayFlag: boolean
  Title: Display

  Maximum Length: 1

  Default Value: true

  The boolean attribute that indicates whether the transaction attribute should be displayed or not, so that it can be used in the promotion criteria. The default value is Y. There is no dependency or limitation associated with this attribute.
• DisplayName: string
  Title: Name

  Maximum Length: 30

  The transaction attribute display name that is displayed to the user. There is no default value, dependency, or limitation associated with this attribute.
• DynamicFlag: boolean
  Title: Dynamic

  Maximum Length: 1

  Default Value: false

  The boolean attribute that indicates whether the transaction attribute value is calculated dynamically based on another attribute, and that is used by the promotion criteria. The criteria can compare an attribute to a value or compare an attribute to another attribute. The default value is N. There is no dependency or limitation associated with this attribute.
• ExpiryAlignCode: string
  Title: Expiration Aligned

  Maximum Length: 30

  The expiry alignment attribute provides the details pertaining to the calculation of the expiry of points. There is no default value, dependency, or limitation associated with this attribute.
• ExpiryBasisCode: string
  Title: Expiration Basis

  Maximum Length: 30

  The basis for point or voucher expiry. The accepted values are Period (expires after a period of time) or Date (expires on a specific date). There is no default value, dependency, or limitation associated with this attribute.
• ExpiryDayCode: string
  Title: Expiration Day Code

  Maximum Length: 30

  The transaction expiry day attribute specifies the day of the month when the points expire if the expiry basis is Date. There is no default value or limitation associated with this attribute. Dependent on Expiry Basis Code.
• ExpiryMonthCode: string
  Title: Expiration Month Code

  Maximum Length: 30

  The transaction expiry month attribute specifies the month when the points expire if the expiry basis is Month. This attribute is dependent on Expiry Basis Code. There is no default value or limitation associated with this attribute.
• ExpPeriodLength: integer
  Title: Expiration Period Length

  The transaction expiry period length attribute is used to specify a length of time after when points expire. For example, if the points expire two years after they are earned, then the length is set to 2. After the points expire, the member can no longer exchange the points for rewards. There is no default value, dependency, or limitation associated with this attribute.
• ExpPeriodUOMCode: string
  Title: Expiration Period Unit of Measure

  Maximum Length: 30

  The transaction expiry period unit of measure (UOM) attribute is used to specify when points expire. For example, if the points expire after they are earned, UOM is Year. After the points expire, the member can no longer exchange the points for rewards. There is no default value, dependency, or limitation associated with this attribute.
• InternalName: string
  Title: Field

  Maximum Length: 75

  The transaction internal name. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the transaction attribute is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the transaction attribute occur. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes take place to the transaction attributes. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes take place to the transaction attributes. There is no default value, dependency, or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyAttrdefnBId: integer (int64)
  Title: Attribute Definition ID

  The primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• MergeActionCode: string
  Title: Merge Action

  Maximum Length: 30

  The transaction merge action attribute specifies how the program handles the attribute during a member merge. There is no default value, dependency, or limitation associated with this attribute.
• MethodName: string
  Title: Method Name

  Maximum Length: 75

  The method that is used in the calculation of the transaction attribute value that can be used in promotion criteria. For example, the ORA_CAL_METHOD_MONTH_NAME method returns the month name. There is no default value, dependency, or limitation associated with this attribute.
• MinimumReactivationQuantity: number
  Title: Minimum Reactivation Quantity

  The minimum points needed to reactivate the expired points so that they can be used for redemption. There is no default value, dependency, or limitation associated with this attribute.
• MonthsLength: number
  Title: Months Length

  The numeric value that corresponds to the number of months when points will expire. There is no default value, dependency, or limitation associated with this attribute.
• ObjectCode: string
  Title: Object Code

  Maximum Length: 30

  Default Value: Transaction

  The option to select values from entities such as Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.
• PickApplet: string
  Title: Pick Applet

  Maximum Length: 75

  The pick applet attribute is a field whose values are entered using a dialog box. When defining criteria and actions, the dialog box with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.
• PickField: string
  Title: Pick Field

  Maximum Length: 75

  The pick field is the field whose value the user sees in the UI after selecting from the pick applet. There is no default value, dependency, or limitation associated with this attribute.
• PickFieldName: string
  Title: Pick Field Name

  Maximum Length: 75

  The pick field name attribute is the user readable string of the PickField attribute. There is no default value, dependency, or limitation associated with this attribute.
• PickList: string
  Title: Pick List

  Maximum Length: 75

  The transaction pick list attribute is enabled if the attribute is a field whose values are entered using a picklist. When defining criteria and actions, the picklist with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.
• PrgFormulaId: integer (int64)
  Title: Program Formula ID

  The program formula identifier that is available for use by a promotion, but only if it is associated with the same program as the program for the promotion. The formula can be used in criteria for comparisons and in actions for assigning values or updating attributes with the formula value. There is no default value, dependency, or limitation associated with this attribute.
• ProgramName: string
  Read Only: true

  The program for which the transaction attribute is created. There is no default value, dependency, or limitation associated with this attribute.
• PromotionId: integer (int64)
  Title: Promotion ID

  The primary key of loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• PromotionName: string
  Read Only: true

  The name of the promotion corresponding to the promotionId attribute. There is no default value, dependency, or limitation associated with this attribute.
• QualPointFlag: boolean
  Title: Qualifying Point

  Maximum Length: 1

  Default Value: false

  The transaction qualifying point attribute is a boolean attribute that indicates that the points accrued when the promotion gets applied count toward earning tier status, but cannot be redeemed for rewards. The default value is N. There is no dependency or limitation associated with this attribute.
• ReactivateFlag: boolean
  Title: Reactivate

  Maximum Length: 1

  Default Value: false

  The reactivate flag attribute reactivates member's points after they have expired. The default value is N. There is no dependency or limitation associated with this attribute.
• ReadonlyFlag: boolean
  Title: Read Only

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the transaction attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.
• RetEffFlag: boolean
  Maximum Length: 1

  Default Value: false

  The transaction effective start date identifier indicates the date when the attribute can be used in promotions. There is no default value, dependency, or limitation associated with this attribute.
• RptExpPdUOMCode: string
  Maximum Length: 30

  The unit of measure (UOM) for the time period until the expired points can be reactivated. The accepted values are Years, Months, Days, and so on. For example, if the reactivation expiry period is one year then the UOM is Year and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.
• RptExpPeriodLength: number
  The time period when the expired points can be reactivated. For example, if the reactivation expiry period is one year, then the time period length is 1 and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.
• TierClassId: integer (int64)
  Title: Tier Class ID

  The primary attribute of the loyalty tier class, which indicates the class to which a specific tier belongs. There is no default value, dependency, or limitation associated with this attribute.
• TierClassName: string
  Read Only: true

  The attribute that indicates the name of the tier class corresponding to tierClassId attribute. There is no default value, dependency, or limitation associated with this attribute.
• WeightFactor: number
  Title: Weight Factor

  The promotion attribute weight factor is used to determine which promotion must be applied to the transaction, if multiple promotions qualify. There is no default value, dependency, or limitation associated with this attribute.
• WeightFactorNq: number
  Title: Weight Factor

  The weight factor non-qualifying attribute is used to determine whether to generate qualifying or non-qualifying points of each type when the weight factor attribute is specified. This attribute has a dependency on the Weight Factor attribute. There is no default value or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "WeightFactor":{
            "title":"Weight Factor",
            "type":"number",
            "description":"The promotion attribute weight factor is used to determine which promotion must be applied to the transaction, if multiple promotions qualify. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the transaction attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new transaction attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionId":{
            "title":"Promotion ID",
            "type":"integer",
            "description":"The primary key of loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DefaultVal":{
            "title":"Default Value",
            "maxLength":75,
            "type":"string",
            "description":"The cost for each point. If you want to allow the product to be redeemed for a combination of points and currency, then enter the amount of money assigned as the cash value of one point. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttrTypeCode":{
            "title":"Attribute Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The transaction attribute type code. This attribute reflects the type of attribute, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":"Field",
            "x-queryable":true
        },
        "AttrDefnId":{
            "title":"Attribute Definition ID",
            "type":"integer",
            "description":"The primary key value of the loyalty attribute definitions corresponding to attribute types like pointType, Member, Transaction, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InternalName":{
            "title":"Field",
            "maxLength":75,
            "type":"string",
            "description":"The transaction internal name. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":30,
            "type":"string",
            "description":"The option to select values from entities such as Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":"Transaction",
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "type":"integer",
            "description":"The currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PromotionName":{
            "type":"string",
            "description":"The name of the promotion corresponding to the promotionId attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RptExpPeriodLength":{
            "type":"number",
            "description":"The time period when the expired points can be reactivated. For example, if the reactivation expiry period is one year, then the time period length is 1 and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "QualPointFlag":{
            "title":"Qualifying Point",
            "maxLength":1,
            "type":"boolean",
            "description":"The transaction qualifying point attribute is a boolean attribute that indicates that the points accrued when the promotion gets applied count toward earning tier status, but cannot be redeemed for rewards. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MethodName":{
            "title":"Method Name",
            "maxLength":75,
            "type":"string",
            "description":"The method that is used in the calculation of the transaction attribute value that can be used in promotion criteria. For example, the ORA_CAL_METHOD_MONTH_NAME method returns the month name. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes take place to the transaction attributes. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The loyalty user that created the transaction attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new transaction attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyExchDt":{
            "title":"Currency Exchange Date",
            "type":"string",
            "description":"The date when the transaction attribute currency exchange takes place. This attribute displays the date of the currency exchange during transaction attributes creation. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramName":{
            "type":"string",
            "description":"The program for which the transaction attribute is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the created transaction attribute 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
        },
        "ReactivateFlag":{
            "title":"Reactivate",
            "maxLength":1,
            "type":"boolean",
            "description":"The reactivate flag attribute reactivates member's points after they have expired. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PickFieldName":{
            "title":"Pick Field Name",
            "maxLength":75,
            "type":"string",
            "description":"The pick field name attribute is the user readable string of the PickField attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpiryMonthCode":{
            "title":"Expiration Month Code",
            "maxLength":30,
            "type":"string",
            "description":"The transaction expiry month attribute specifies the month when the points expire if the expiry basis is Month. This attribute is dependent on Expiry Basis Code. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "WeightFactorNq":{
            "title":"Weight Factor",
            "type":"number",
            "description":"The weight factor non-qualifying attribute is used to determine whether to generate qualifying or non-qualifying points of each type when the weight factor attribute is specified. This attribute has a dependency on the Weight Factor attribute. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ReadonlyFlag":{
            "title":"Read Only",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the transaction attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PickList":{
            "title":"Pick List",
            "maxLength":75,
            "type":"string",
            "description":"The transaction pick list attribute is enabled if the attribute is a field whose values are entered using a picklist. When defining criteria and actions, the picklist with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayFlag":{
            "title":"Display",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that indicates whether the transaction attribute should be displayed or not, so that it can be used in the promotion criteria. The default value is Y. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "DataTypeCode":{
            "title":"Data Type",
            "maxLength":30,
            "type":"string",
            "description":"The promotion attribute data type name indicates whether the attribute is a string, or number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "RptExpPdUOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure (UOM) for the time period until the expired points can be reactivated. The accepted values are Years, Months, Days, and so on. For example, if the reactivation expiry period is one year then the UOM is Year and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last updated the attribute. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes take place to the transaction attributes. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostperPoint":{
            "type":"number",
            "description":"The cost for each point. If you want to allow the product to be redeemed for a combination of points and currency, then enter the amount of money assigned as the cash value of one point. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CancelActnCode":{
            "title":"Cancel Action Code",
            "maxLength":30,
            "type":"string",
            "description":"The specification of the action that must be applied during a transaction cancellation. The accepted values are Leave As Is (if selected, the value of the attribute remains the same when a transaction is cancelled), Revert, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "MergeActionCode":{
            "title":"Merge Action",
            "maxLength":30,
            "type":"string",
            "description":"The transaction merge action attribute specifies how the program handles the attribute during a member merge. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PickField":{
            "title":"Pick Field",
            "maxLength":75,
            "type":"string",
            "description":"The pick field is the field whose value the user sees in the UI after selecting from the pick applet. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExpPeriodLength":{
            "title":"Expiration Period Length",
            "type":"integer",
            "description":"The transaction expiry period length attribute is used to specify a length of time after when points expire. For example, if the points expire two years after they are earned, then the length is set to 2. After the points expire, the member can no longer exchange the points for rewards. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumReactivationQuantity":{
            "title":"Minimum Reactivation Quantity",
            "type":"number",
            "description":"The minimum points needed to reactivate the expired points so that they can be used for redemption. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DynamicFlag":{
            "title":"Dynamic",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that indicates whether the transaction attribute value is calculated dynamically based on another attribute, and that is used by the promotion criteria. The criteria can compare an attribute to a value or compare an attribute to another attribute. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ExpPeriodUOMCode":{
            "title":"Expiration Period Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"The transaction expiry period unit of measure (UOM) attribute is used to specify when points expire. For example, if the points expire after they are earned, UOM is Year. After the points expire, the member can no longer exchange the points for rewards. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The transaction attribute display name that is displayed to the user. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "TierClassId":{
            "title":"Tier Class ID",
            "type":"integer",
            "description":"The primary attribute of the loyalty tier class, which indicates the class to which a specific tier belongs. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DataType":{
            "title":"Data Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The transaction attribute data type indicates whether the attribute is a string, or a number, and so on. During a transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for the String and Number data types, and the Leave As Is action is available for all data types. There is no default value or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "RetEffFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The transaction effective start date identifier indicates the date when the attribute can be used in promotions. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "MonthsLength":{
            "title":"Months Length",
            "type":"number",
            "description":"The numeric value that corresponds to the number of months when points will expire. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "TierClassName":{
            "type":"string",
            "description":"The attribute that indicates the name of the tier class corresponding to tierClassId attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpiryBasisCode":{
            "title":"Expiration Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis for point or voucher expiry. The accepted values are Period (expires after a period of time) or Date (expires on a specific date). There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PickApplet":{
            "title":"Pick Applet",
            "maxLength":75,
            "type":"string",
            "description":"The pick applet attribute is a field whose values are entered using a dialog box. When defining criteria and actions, the dialog box with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpiryAlignCode":{
            "title":"Expiration Aligned",
            "maxLength":30,
            "type":"string",
            "description":"The expiry alignment attribute provides the details pertaining to the calculation of the expiry of points. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AccntActCode":{
            "title":"Account Activity",
            "maxLength":30,
            "type":"string",
            "description":"The transaction attribute account activity code. If this option is specified, points expire if there is no activity of the type within the period specified for the point type. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpiryDayCode":{
            "title":"Expiration Day Code",
            "maxLength":30,
            "type":"string",
            "description":"The transaction expiry day attribute specifies the day of the month when the points expire if the expiry basis is Date. There is no default value or limitation associated with this attribute. Dependent on Expiry Basis Code.",
            "nullable":true,
            "x-queryable":true
        },
        "LoyAttrdefnBId":{
            "title":"Attribute Definition ID",
            "type":"integer",
            "description":"The primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PrgFormulaId":{
            "title":"Program Formula ID",
            "type":"integer",
            "description":"The program formula identifier that is available for use by a promotion, but only if it is associated with the same program as the program for the promotion. The formula can be used in criteria for comparisons and in actions for assigning values or updating attributes with the formula value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "BusSvcName":{
            "title":"Business Service Name",
            "maxLength":75,
            "type":"string",
            "description":"The external business service that can be called in the promotion to evaluate the business criteria. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the transaction attribute is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the transaction attribute occur. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : loyPrograms-TransactionRestrictions-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The loyalty user that created the transaction restriction. Oracle Loyalty Cloud generates this attribute value during the creation of a new transaction restriction record. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the transaction restriction is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new transaction restriction record. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the transaction restriction record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the transaction restriction record occur. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user that last updated the transaction restriction. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the transaction restriction. There is no dependency or limitation associated with this attribute.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user that last logged in. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the transaction restriction. There is no dependency or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProgramName: string
  Title: Program

  Read Only: true

  Maximum Length: 50

  The program for which transaction restriction record is created. There is no default value, dependency, or limitation associated with this attribute.
• RestrictAccrualFlag: boolean
  Title: Restrict Accrual

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the created transaction restriction is restricted for accrual or not. The default value is N. There is no dependency or limitation associated with this attribute.
• RestrictRedemptionFlag: boolean
  Title: Restrict Redemption

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the created transaction restriction is restricted for redemption or not. The default value is N. There is no dependency or limitation associated with this attribute.
• Status: string
  Title: Status Meaning

  Read Only: true

  Maximum Length: 80

  The status of the member for which transaction restriction is created. There is no default value, dependency, or limitation associated with this attribute.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  The status code of member for which transaction restriction is created. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the transaction restriction. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the transaction restriction. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The status of the member for which transaction restriction is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the transaction restriction is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new transaction restriction record. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The loyalty user that created the transaction restriction. Oracle Loyalty Cloud generates this attribute value during the creation of a new transaction restriction record. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RestrictAccrualFlag":{
            "title":"Restrict Accrual",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the created transaction restriction is restricted for accrual or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RestrictRedemptionFlag":{
            "title":"Restrict Redemption",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the created transaction restriction is restricted for redemption or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Program",
            "maxLength":50,
            "type":"string",
            "description":"The program for which transaction restriction record is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code of member for which transaction restriction is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the transaction restriction record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the transaction restriction record occur. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last logged in. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the transaction restriction. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

CalendarAttributes

Operation: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/CalendarAttributes

Parameters:

• LoyProgramId: $request.path.LoyProgramId

The calendar attributes resource is used to retrieve the details of the calendar attributes defined for the program.

MemberAttributes

Operation: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/MemberAttributes

Parameters:

• LoyProgramId: $request.path.LoyProgramId

The member attributes resource is used to retrieve the details of the member attributes defined for the program.

MemberFieldAttributes

Operation: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/MemberFieldAttributes

Parameters:

• LoyProgramId: $request.path.LoyProgramId

The member field attributes resource is used to retrieve the details of the member field attributes defined for the program.

MemberTierAttributes

Operation: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/MemberTierAttributes

Parameters:

• LoyProgramId: $request.path.LoyProgramId

The member tier attributes resource is used to retrieve the details of the member tier attributes defined for the loyalty program.

NegativePoints

Operation: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/NegativePoints

Parameters:

• LoyProgramId: $request.path.LoyProgramId

The negative points resource is used to retrieve the details of negative points defined for the loyalty program.

PointBlocks

Operation: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointBlocks

Parameters:

• LoyProgramId: $request.path.LoyProgramId

The point blocks resource is used to retrieve the details of the point block defined for the partner.

PointSubtypes

Operation: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointSubtypes

Parameters:

• LoyProgramId: $request.path.LoyProgramId

The point subtypes resource is used to retrieve the details of the loyalty point subtypes defined for the program.

PointTotalsAttributes

Operation: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointTotalsAttributes

Parameters:

• LoyProgramId: $request.path.LoyProgramId

The point total attributes resource is used to retrieve the details of the point totals attributes defined for the program.

PointTypes

Operation: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointTypes

Parameters:

• LoyProgramId: $request.path.LoyProgramId

The point types resource is used to retrieve the details of the loyalty point types defined for the program.

ProgramPartners

Operation: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/ProgramPartners

Parameters:

• LoyProgramId: $request.path.LoyProgramId

The program partners resource is used to retrieve the details of the loyalty partners defined for the program.

RedemptionProducts

Operation: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/RedemptionProducts

Parameters:

• LoyProgramId: $request.path.LoyProgramId

The redemption products resource is used to retrieve the details of the redemption products defined for the program.

TierClasses

Operation: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/TierClasses

Parameters:

• LoyProgramId: $request.path.LoyProgramId

The tier classes resource is used to retrieve the details of a tier class defined for the program.

TransactionAttributes

Operation: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/TransactionAttributes

Parameters:

• LoyProgramId: $request.path.LoyProgramId

The transaction attributes resource is used to retrieve the details of the transaction attributes defined for the program.

TransactionRestrictions

Operation: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/TransactionRestrictions

Parameters:

• LoyProgramId: $request.path.LoyProgramId

The transaction restrictions resource is used to retrieve the details of the transaction restrictions defined for the loyalty program.

events

Operation: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/events

Parameters:

• LoyProgramId: $request.path.LoyProgramId

The events resource is used to retrieve the details of the event defined for the loyalty program.

Back to Top

Examples

This example shows how to retrieve a loyalty program.

Use GET with the following URI syntax to retrieve a program named Auto Miles with a program identifier 300100129314462:

https://example.com:port/crmRestApi/resources/11.13.18.05/loyPrograms/300100129314462

Example of Response Header

cache-control -no-cache, no-store, must-revalidate
connection -Keep-Alive
content-encoding -gzip
content-language -en
content-length -1064
content-type -application/vnd.oracle.adf.resourceitem+json
date -Wed, 22 Aug 2018 17:49:07 GMT
etag -"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
keep-alive -timeout=61, max=100
link - <https://example.com:port/crmRestApi/resources/11.13.18.05/loyPrograms/300100129314462>;rel="self";kind="item";name="loyPrograms"
location -
rest-framework-version -1
server -Oracle-HTTP-Server
vary -User-Agent
x-content-type-options -nosniff
x-oracle-dms-ecid -005T0b2MM4uEoIILIqL6if0001wh0001Fz

Example of Response Body

{
    "LoyProgramId": 300100129314462,
    "CreatedBy": "LOYALTY_PROGRAM_ADMINISTRATOR",
    "LastUpdatedBy": "LOYALTY_PROGRAM_ADMINISTRATOR",
    "LastUpdateLogin": "72FF167553375640E05334C4F00AFD42",
    "CreationDate": "2018-08-09T12:10:27+00:00",
    "LastUpdateDate": "2018-08-09T12:14:50+00:00",
    "Name": "Auto Miles",
    "BUId": 0,
    "ActiveFlag": true,
    "PartnerFlag": false,
    "EndDate": null,
    "ApplyCode": null,
    "HostOrgId": null,
    "MemberCount": null,
    "MemberShared": null,
    "DescriptionText": "Program for capturing automobile reward points",
    "PointExpLevelCode": "Tier Level",
    "PurchaseStartMonthCode": "January",
    "PurchaseStartDayCode": "1",
    "TransferStartMonthCode": "January",
    "TransferStartDayCode": "1",
    "PointsToPayFlag": false,
    "RevenueRecongnitionPeriodDuration": null,
    "BatchRedemptionPeriodTypeCode": null,
    "BatchRedemptionPeriodDuration": null,
    "ThresholdPointVal": null,
    "PointTypeId": null,
    "RevenueRecongnitionPeriodTypeCode": null,
    "StartDt": "2018-08-09T00:00:00+00:00",
    "DeletedFlag": false,
    "ProgramOwner": "Auto Miles",
    "EnableReferralBonusFlag": false,
    "EnableEnrollmentBonusFlag": false,
    "PrimaryPointTpId": 300100129314487,
    "AllowNegPointFlag": false,
    "links": [
        {
            "rel": "self",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPrograms/300100129314462",
            "name": "loyPrograms",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPrograms/300100129314462",
            "name": "loyPrograms",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPrograms/300100129314462/lov/PointTypePVO1",
            "name": "PointTypePVO1",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPrograms/300100129314462/child/ProgramPartners",
            "name": "ProgramPartners",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPrograms/300100129314462/child/TransactionRestrictions",
            "name": "TransactionRestrictions",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPrograms/300100129314462/child/PointTotalsAttributes",
            "name": "PointTotalsAttributes",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPrograms/300100129314462/child/RedemptionProducts",
            "name": "RedemptionProducts",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPrograms/300100129314462/child/MemberAttributes",
            "name": "MemberAttributes",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPrograms/300100129314462/child/CalendarAttributes",
            "name": "CalendarAttributes",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPrograms/300100129314462/child/PointSubtypes",
            "name": "PointSubtypes",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPrograms/300100129314462/child/NegativePoints",
            "name": "NegativePoints",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPrograms/300100129314462/child/MemberTierAttributes",
            "name": "MemberTierAttributes",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPrograms/300100129314462/child/TierClasses",
            "name": "TierClasses",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPrograms/300100129314462/child/PointTypes",
            "name": "PointTypes",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPrograms/300100129314462/child/MemberFieldAttributes",
            "name": "MemberFieldAttributes",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPrograms/300100129314462/child/TransactionAttributes",
            "name": "TransactionAttributes",
            "kind": "collection"
        }
    ]
}

Back to Top