Jump to

• Request
• Response

Get a point total attribute

get

/crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointTotalsAttributes/{PointTotalsAttributesUniqID}

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.
• PointTotalsAttributesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Point Total Attributes resource and used to uniquely identify an instance of Point Total Attributes. The client should not generate the hash key value. Instead, the client should query on the Point Total Attributes collection resource in order to navigate to a specific instance of Point Total Attributes to get the hash key.

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:
  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.

Body ()

Root 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 : 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."
        }
    }
}

Links

LoyLookupPVO1

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder

The lookups resource is used to view standard lookup codes.

Back to Top