Create a collection of all events
post
/crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/events
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.
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.
-
Upsert-Mode:
When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:false
The boolean attribute that specifies whether the created event is enabled for use or not. The default value is N. There is no dependency or limitation associated with this attribute. -
CoolOffPeriodInWeeks: number
Title:
Cooling off Period in Weeks
Default Value:0
The cool off period for the event defined for the loyalty program. This is the period for which Oracle Loyalty Cloud checks if an event is already created for the member or not. There is no default value, dependency, or limitation associated with this attribute. -
EventName(required): string
Title:
Event Name
Maximum Length:75
The event defined in the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
eventTransactionAttributes: array
Event Transaction Attributes
Title:
Event Transaction Attributes
The event transaction attributes resource is used to retrieve the details of the event terms defined for the event. -
IgnoreYearFlag: boolean
Title:
Ignore Year
Maximum Length:1
Default Value:false
The boolean attribute that specifies weather year can be ignored from the date for the event. The default value is N. There is no dependency or limitation associated with this attribute. -
LoyEventId: integer
(int64)
The loyalty event identifier for uniquely identifying an event from a program. There is no default value, dependency, or limitation associated with this attribute.
-
MemberAttributeName: string
Title:
Member Attribute
The name of the member attribute defined for the event. There is no default value, dependency, or limitation associated with this attribute. -
NegativeOffsetDays: number
Title:
Subtracted Days
Default Value:0
The negative offset days for the event defined for the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PositiveOffsetDays: number
Title:
Added Days
Default Value:0
The positive offset days for the event defined for the loyalty program. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Event Transaction Attributes
Type:
array
Title:
Event Transaction Attributes
The event transaction attributes resource is used to retrieve the details of the event terms defined for the event.
Show Source
Nested Schema : loyPrograms-events-eventTransactionAttributes-item-post-request
Type:
Show Source
object
-
EventAttrId: integer
(int64)
The event attribute identifier. There is no default value, dependency, or limitation associated with this attribute.
-
InvOrgId: integer
(int64)
The organization from where inventory is being picked. For example, when a transaction is created, the inventory or goods might be picked from the partner and directly delivered to the customer. That is, the transaction is created for one organization, but the inventory is picked from a different organization. There is no default value, dependency, or limitation associated with this attribute.
-
MemberAttrName: string
Title:
Member Attribute
The name of the member attribute defined for the event transaction. There is no default value, dependency, or limitation associated with this attribute. -
ProdId: integer
(int64)
The loyalty product identifier. This attribute describes the product that is going to be used in the event transaction that has been created.There is no default value, dependency, or limitation associated with this attribute.
-
ProductNumber: string
The loyalty product number. This attribute describes the product that is going to be used in the event transaction that has been created.There is no default value, dependency, or limitation associated with this attribute.
-
TransactionAttrName: string
Title:
Attribute
The transaction attribute name of the event transaction attribute defined for the event. There is no default value, dependency, or limitation associated with this attribute. -
TransactionAttrValue: string
Title:
Fixed Value
Maximum Length:75
The transaction attribute value of the event transaction attribute defined for the event. There is no default value, dependency, or limitation associated with this attribute.
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.
Root Schema : loyPrograms-events-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:false
The boolean attribute that specifies whether the created event is enabled for use or not. The default value is N. There is no dependency or limitation associated with this attribute. -
CoolOffPeriodInWeeks: number
Title:
Cooling off Period in Weeks
Default Value:0
The cool off period for the event defined for the loyalty program. This is the period for which Oracle Loyalty Cloud checks if an event is already created for the member or not. There is no default value, dependency, or limitation associated with this attribute. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The loyalty user that created the event. Oracle Loyalty Cloud generates this attribute value during the creation of a new event record. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Read Only:
true
The date when the event is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new event record. There is no default value, dependency, or limitation associated with this attribute. -
EventName: string
Title:
Event Name
Maximum Length:75
The event defined in the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
eventTransactionAttributes: array
Event Transaction Attributes
Title:
Event Transaction Attributes
The event transaction attributes resource is used to retrieve the details of the event terms defined for the event. -
IgnoreYearFlag: boolean
Title:
Ignore Year
Maximum Length:1
Default Value:false
The boolean attribute that specifies weather year can be ignored from the date for the event. The default value is N. There is no dependency or limitation associated with this attribute. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the event record was last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the event record occur. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the event. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the event. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user that last logged in to Oracle Loyalty Cloud. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the events. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoyEventId: integer
(int64)
The loyalty event identifier for uniquely identifying an event from a program. There is no default value, dependency, or limitation associated with this attribute.
-
MemberAttributeName: string
Title:
Member Attribute
The name of the member attribute defined for the event. There is no default value, dependency, or limitation associated with this attribute. -
NegativeOffsetDays: number
Title:
Subtracted Days
Default Value:0
The negative offset days for the event defined for the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PositiveOffsetDays: number
Title:
Added Days
Default Value:0
The positive offset days for the event defined for the loyalty program. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Event Transaction Attributes
Type:
array
Title:
Event Transaction Attributes
The event transaction attributes resource is used to retrieve the details of the event terms defined for the event.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : loyPrograms-events-eventTransactionAttributes-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The loyalty user that created the event transaction attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new event transaction attribute record. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Read Only:
true
The date when the event transaction attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new event transaction attribute record. There is no default value, dependency, or limitation associated with this attribute. -
EventAttrId: integer
(int64)
The event attribute identifier. There is no default value, dependency, or limitation associated with this attribute.
-
InvOrgId: integer
(int64)
The organization from where inventory is being picked. For example, when a transaction is created, the inventory or goods might be picked from the partner and directly delivered to the customer. That is, the transaction is created for one organization, but the inventory is picked from a different organization. There is no default value, dependency, or limitation associated with this attribute.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the event transaction attribute record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the event transaction attribute record occur. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the event transaction attribute. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the event transaction attribute. There is no dependency or limitation associated with this attribute. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The user that last updated the event transaction attribute. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the event transaction attribute. There is no dependency or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberAttrName: string
Title:
Member Attribute
The name of the member attribute defined for the event transaction. There is no default value, dependency, or limitation associated with this attribute. -
ProdId: integer
(int64)
The loyalty product identifier. This attribute describes the product that is going to be used in the event transaction that has been created.There is no default value, dependency, or limitation associated with this attribute.
-
ProductNumber: string
The loyalty product number. This attribute describes the product that is going to be used in the event transaction that has been created.There is no default value, dependency, or limitation associated with this attribute.
-
TransactionAttrName: string
Title:
Attribute
The transaction attribute name of the event transaction attribute defined for the event. There is no default value, dependency, or limitation associated with this attribute. -
TransactionAttrValue: string
Title:
Fixed Value
Maximum Length:75
The transaction attribute value of the event transaction attribute defined for the event. There is no default value, dependency, or limitation associated with this attribute.
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.
Links
- eventTransactionAttributes
-
Parameters:
- LoyEventId:
$request.path.LoyEventId
- LoyProgramId:
$request.path.LoyProgramId
The event transaction attributes resource is used to retrieve the details of the event terms defined for the event. - LoyEventId: