Jump to

• Request
• Response

Get a promotion attribute (Deprecated)

get

/crmRestApi/resources/11.13.18.05/loyaltyPromotions/{LoyPromoId}/child/PromotionAttributes/{LoyAttrdefnBId}

Request

Path Parameters

• LoyAttrdefnBId(required): integer(int64)
  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.
• LoyPromoId(required): integer(int64)
  The primary key to identify the promotion. Oracle Loyalty Cloud generates this attribute value during the creation of a promotion 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 : loyaltyPromotions-PromotionAttributes-item-response

Type: object

Show Source

• AccntActCode: string
  Read Only: true

  Maximum Length: 30

  The promotion attribute account activity code. If this option is specified, points expire if there is no activity of the type for the point type, within the period specified. There is no default value, dependency, or limitation associated with this attribute.
• ActiveFlg: string
  Read Only: true

  Maximum Length: 1

  The boolean attribute that specifies whether the created promotion 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)
  Read Only: true

  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
  Read Only: true

  Maximum Length: 30

  The promotion 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
  Read Only: true

  Maximum Length: 75

  The external business service that can be called in a promotion to evaluate the business criteria. There is no default value, dependency, or limitation associated with this attribute.
• CancelActionName: string
  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.
• ConflictId: integer (int64)
  Read Only: true

  The promotion attribute conflict identifier that Oracle Loyalty Cloud generates during the creation of a new promotion attribute. There is no default value, dependency, or limitation associated with this attribute.
• CostperPoint: number
  Read Only: true

  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
  Read Only: true

  Maximum Length: 64

  The details of 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)
  Read Only: true

  The date when the promotion is created. 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.
• CurcyCode: integer (int64)
  Read Only: true

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

  The date when the promotion attribute currency exchange takes place. This attribute displays the date of the currency exchange during promotion attributes creation. There is no default value, dependency, or limitation associated with this attribute.
• DataTypeName: string
  The promotion 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 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
  Read Only: true

  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
  Read Only: true

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

  Maximum Length: 1

  The boolean attribute that indicates whether the promotion 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
  Read Only: true

  Maximum Length: 30

  The promotion attribute display name that is displayed on the UI. There is no default value, dependency, or limitation associated with this attribute.
• DynamicFlg: string
  Read Only: true

  Maximum Length: 1

  The boolean attribute that indicates whether the promotion 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
  Read Only: true

  Maximum Length: 30

  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
  Read Only: true

  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
  Read Only: true

  Maximum Length: 30

  The day of the month when the points expire if the expiry basis is set to Date. The attribute has a dependency on the Expiry Basis Code attribute. There is no default value or limitation associated with this attribute.
• ExpiryMonthCode: string
  Read Only: true

  Maximum Length: 30

  The month when the points expire if the expiry basis is Month. The attribute has a dependency on the Expiry Basis Code attribute. There is no default value or limitation associated with this attribute.
• ExpPdUOMCode: string
  Read Only: true

  Maximum Length: 30

  The promotion attribute 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.
• ExpPeriodLen: number
  Read Only: true

  The promotion 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
  Read Only: true

  Maximum Length: 75

  The promotion 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)
  Read Only: true

  The date when the promotion attribute is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes occur to the promotion attributes. 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 promotion. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes occur to the promotion attributes. 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 promotion. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes occur 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)
  Read Only: true

  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
  Read Only: true

  Maximum Length: 30

  The promotion 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
  Read Only: true

  Maximum Length: 75

  The method that is used in calculations 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.
• MinimumReactivatnQuantity: number
  Read Only: true

  The minimum points required to reactive the expired points, so they can be used for redemption. There is no default value, dependency, or limitation associated with this attribute.
• MonthsLen: number
  Read Only: true

  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
  Read Only: true

  Maximum Length: 30

  The option to select values from the entities like Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The promotion attribute object version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
• PickApplet: string
  Read Only: true

  Maximum Length: 75

  The pick applet field whose values are entered using a dialog box. When you are defining criteria and actions, then 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
  Read Only: true

  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
  Read Only: true

  Maximum Length: 75

  The promotion attribute pick field name is the user readable string of the attribute PickField. There is no default value, dependency, or limitation associated with this attribute.
• PickList: string
  Read Only: true

  Maximum Length: 75

  The promotion attribute pick list is enabled if the attribute is a field whose values are entered using a picklist. When you are 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)
  Read Only: true

  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.
• PromotionId: integer (int64)
  Read Only: true

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

  Maximum Length: 1

  The boolean attribute that indicates that the points accrued when the promotion are applied towards earning tier status, but that cannot be redeemed for rewards. The default value is N. There is no dependency or limitation associated with this attribute.
• ReactivateFlg: string
  Read Only: true

  Maximum Length: 1

  The reactivate flag attribute is used to reactivate members points after they have expired. The default value is N. There is no dependency or limitation associated with this attribute.
• ReadonlyFlg: string
  Read Only: true

  Maximum Length: 1

  The boolean attribute specifies whether the promotion attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.
• RetEffFlg: string
  Read Only: true

  Maximum Length: 1

  The date when the attribute can be used in promotions. There is no default value, dependency, or limitation associated with this attribute.
• RptExpPdUOMCode: string
  Read Only: true

  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.
• RptExpPeriodLen: number
  Read Only: true

  The time period until 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)
  Read Only: true

  The primary attribute of the loyalty tier class that indicates the class where a specific tier falls. There is no default value, dependency, or limitation associated with this attribute.
• WeightFactor: number
  Read Only: true

  The promotion attribute weight factor is used to decide 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
  Read Only: true

  The promotion attribute weight factor non-qualifying attribute is used to decide 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":{
            "type":"number",
            "description":"The promotion attribute weight factor is used to decide 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,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the promotion is created. 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.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MonthsLen":{
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionId":{
            "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,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DefaultVal":{
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "AttrTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The promotion 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,
            "readOnly":true,
            "x-queryable":true
        },
        "AttrDefnId":{
            "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,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReactivateFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The reactivate flag attribute is used to reactivate members points after they have expired. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The boolean attribute that indicates whether the promotion 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,
            "readOnly":true,
            "x-queryable":true
        },
        "InternalName":{
            "maxLength":75,
            "type":"string",
            "description":"The promotion attribute internal name. 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
        },
        "ObjectCode":{
            "maxLength":30,
            "type":"string",
            "description":"The option to select values from the entities like Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The promotion attribute conflict identifier that Oracle Loyalty Cloud generates during the creation of a new promotion attribute. 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
        },
        "DisplayFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The boolean attribute that indicates whether the promotion 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,
            "readOnly":true,
            "x-queryable":true
        },
        "CancelActionName":{
            "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-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MethodName":{
            "maxLength":75,
            "type":"string",
            "description":"The method that is used in calculations 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,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the promotion. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes occur to the promotion attributes. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The details of 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
        },
        "ExpPdUOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"The promotion attribute 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,
            "readOnly":true,
            "x-queryable":true
        },
        "PickFieldName":{
            "maxLength":75,
            "type":"string",
            "description":"The promotion attribute pick field name is the user readable string of the attribute PickField. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyCode":{
            "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,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExpiryMonthCode":{
            "maxLength":30,
            "type":"string",
            "description":"The month when the points expire if the expiry basis is Month. The attribute has a dependency on the Expiry Basis Code attribute. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WeightFactorNq":{
            "type":"number",
            "description":"The promotion attribute weight factor non-qualifying attribute is used to decide 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,
            "readOnly":true,
            "x-queryable":true
        },
        "PickList":{
            "maxLength":75,
            "type":"string",
            "description":"The promotion attribute pick list is enabled if the attribute is a field whose values are entered using a picklist. When you are 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,
            "readOnly":true,
            "x-queryable":true
        },
        "RetEffFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The date when the attribute can be used in promotions. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last updated the promotion. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes occur 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,
            "readOnly":true,
            "x-queryable":true
        },
        "MergeActionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The promotion 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,
            "readOnly":true,
            "x-queryable":true
        },
        "ReadonlyFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The boolean attribute 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,
            "readOnly":true,
            "x-queryable":true
        },
        "PickField":{
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "QualPointFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The boolean attribute that indicates that the points accrued when the promotion are applied towards earning tier status, but that cannot be redeemed for rewards. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The promotion attribute object version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "DisplayName":{
            "maxLength":30,
            "type":"string",
            "description":"The promotion attribute display name that is displayed on the UI. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TierClassId":{
            "type":"integer",
            "description":"The primary attribute of the loyalty tier class that indicates the class where a specific tier falls. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DataTypeName":{
            "type":"string",
            "description":"The promotion 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 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,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExpiryBasisCode":{
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumReactivatnQuantity":{
            "type":"number",
            "description":"The minimum points required to reactive the expired points, so they can be used for redemption. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PickApplet":{
            "maxLength":75,
            "type":"string",
            "description":"The pick applet field whose values are entered using a dialog box. When you are defining criteria and actions, then 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,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpiryAlignCode":{
            "maxLength":30,
            "type":"string",
            "description":"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,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyExchDt":{
            "type":"string",
            "description":"The date when the promotion attribute currency exchange takes place. This attribute displays the date of the currency exchange during promotion attributes creation. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RptExpPeriodLen":{
            "type":"number",
            "description":"The time period until 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,
            "readOnly":true,
            "x-queryable":true
        },
        "AccntActCode":{
            "maxLength":30,
            "type":"string",
            "description":"The promotion attribute account activity code. If this option is specified, points expire if there is no activity of the type for the point type, within the period specified. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpiryDayCode":{
            "maxLength":30,
            "type":"string",
            "description":"The day of the month when the points expire if the expiry basis is set to Date. The attribute has a dependency on the Expiry Basis Code attribute. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LoyAttrdefnBId":{
            "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,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrgFormulaId":{
            "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\nin 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,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActiveFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The boolean attribute that specifies whether the created promotion attribute is enabled for use or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpPeriodLen":{
            "type":"number",
            "description":"The promotion 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,
            "readOnly":true,
            "x-queryable":true
        },
        "DescriptionText":{
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "BusSvcName":{
            "maxLength":75,
            "type":"string",
            "description":"The external business service that can be called in a promotion to evaluate the business criteria. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the promotion attribute is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes occur to the promotion 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 : 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."
        }
    }
}

Back to Top