Get all promotion attributes
get
/crmRestApi/resources/11.13.18.05/loyPromotions/{LoyPromoId}/child/PromotionAttributes
Request
Path Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the promotion attribute with specified attribute definition identifier.
Finder Variables:- LoyAttrdefnBId; integer; The attribute definition identifier.
- PrimaryKey: Finds the promotion attribute with specified attribute definition identifier.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActiveFlag; boolean; 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.
- CancelActn; 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.
- CancelActnCode; 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.
- CreatedBy; string; 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; 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.
- DataType; string; The promotion attribute data type 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; 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.
- DisplayName; string; The promotion attribute display name that is displayed on the UI. There is no default value, dependency, or limitation associated with this attribute.
- InternalName; string; 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; 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.
- LastUpdateLogin; string; 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.
- LastUpdatedBy; string; 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.
- LoyAttrdefnBId; integer; The primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
- ObjectCode; string; The option to select values from entities like Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.
- PickApplet; string; 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; 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; The promotion attribute pick field name is the user readable string of the PickField attribute. There is no default value, dependency, or limitation associated with this attribute.
- PickList; string; 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.
- PromotionId; integer; 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.
- PromotionNumber; string; The promotion number to which the promotion attribute belongs. There is no default value, dependency, or limitation associated with this attribute.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 TopResponse
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.
Root Schema : loyPromotions-PromotionAttributes
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : loyPromotions-PromotionAttributes-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:false
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. -
CancelActn: string
Title:
Cancel Action Meaning
Read Only:true
Maximum Length:80
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. -
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. -
CreatedBy: string
Title:
Created By
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)
Title:
Creation Date
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. -
DataType: string
Title:
Data Type Meaning
Read Only:true
Maximum Length:80
The promotion attribute data type 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
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. -
DisplayName: string
Title:
Name
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. -
InternalName: string
Title:
Field
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)
Title:
Last Update Date
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
Title:
Last Updated By
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
Title:
Last Update Login
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)
Title:
Attribute Definition ID
The primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute. -
ObjectCode: string
Title:
Object Code
Maximum Length:30
The option to select values from entities like 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 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
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 promotion attribute pick field name is the user readable string of the PickField attribute. There is no default value, dependency, or limitation associated with this attribute. -
PickList: string
Title:
Pick List
Maximum Length:75
The 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. -
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. -
PromotionNumber: string
Title:
Promotion Number
Read Only:true
Maximum Length:30
The promotion number to which the promotion attribute belongs. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.