Jump to

• Request
• Response

Update an event transaction attribute

patch

/crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/events/{LoyEventId}/child/eventTransactionAttributes/{EventAttrId}

Request

Path Parameters

• EventAttrId(required): integer(int64)
  The event attribute identifier. There is no default value, dependency, or limitation associated with this attribute.
• LoyEventId(required): 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.
• 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.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "MemberAttrName":{
            "title":"Member Attribute",
            "type":"string",
            "description":"The name of the member attribute defined for the event transaction. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The organization from where inventory is being picked. For example, when a transaction is created, the inventory or goods might be picked from the partner and directly delivered to the customer. That is, the transaction is created for one organization, but the inventory is picked from a different organization. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProductNumber":{
            "type":"string",
            "description":"The loyalty product number. This attribute describes the product that is going to be used in the event transaction that has been created.There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionAttrValue":{
            "title":"Fixed Value",
            "maxLength":75,
            "type":"string",
            "description":"The transaction attribute value of the event transaction attribute defined for the event. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProdId":{
            "type":"integer",
            "description":"The loyalty product identifier. This attribute describes the product that is going to be used in the event transaction that has been created.There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TransactionAttrName":{
            "title":"Attribute",
            "type":"string",
            "description":"The transaction attribute name of the event transaction attribute defined for the event. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

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

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

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

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

  Maximum Length: 64

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

  Maximum Length: 32

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

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

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

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

  Maximum Length: 75

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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