Jump to

• Request
• Response

Get a loyalty promotion attribute updated during transaction processing

get

/crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/Promotions/{PromotionId}/child/PromotionAttributes/{PromotionAttributesUniqID}

Request

Path Parameters

• LoyTransactionId(required): integer(int64)
  The primary key to identify a transaction. Oracle Loyalty Cloud generates this attribute value during the creation of a transaction record. There is no default value, dependency, or limitation associated with this attribute.
• PromotionAttributesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Promotion Attributes resource and used to uniquely identify an instance of Promotion Attributes. The client should not generate the hash key value. Instead, the client should query on the Promotion Attributes collection resource in order to navigate to a specific instance of Promotion Attributes to get the hash key.
• PromotionId(required): integer(int64)
  The primary key to identify a loyalty promotion. Oracle Loyalty Cloud generates this attribute value when a new promotion is set up. There is no default value, dependency, or limitation associated with this attribute.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : loyTransactions-Promotions-PromotionAttributes-item-response

Type: object

Show Source

• ActionNote: string
  Title: Action Note

  Maximum Length: 1000

  The attribute indicates additional information pertaining to an action that resulted in the creation of the promotion attribute. There is no default value or limitation associated with this attribute.
• Active: string
  Title: Active

  Read Only: true

  Maximum Length: 1

  Default Value: N

  The promotion attribute active flag. This attribute is a boolean flag that indicates whether the promotion attribute is active or not. There is no default value, dependency, or limitation associated with this attribute.
• AttrDefnId: integer (int64)
  Title: Attribute Definition ID

  Read Only: true

  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.
• AttribDefnId: integer (int64)
  Title: Attribute Definition ID

  The attribute definition identifier that results from transaction processing. There is no default value, dependency, or limitation associated with this attribute.
• AttrTypeCode: string
  Title: Attribute Type Code

  Read Only: true

  Maximum Length: 30

  The promotion attribute type code. This attribute reflects the type of attribute, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.
• BucketUid: string
  Title: Alternate Loyalty Milestone ID

  Read Only: true

  Maximum Length: 30

  The unique key to identify a bucket record. This attribute is automatically generated by Oracle Loyalty Cloud. 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 name indicates whether the attribute is a string, or a number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.
• DataTypeCode: string
  Title: Data Type

  Read Only: true

  Maximum Length: 30

  The promotion attribute data type name indicates whether the attribute is a string, or a number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.
• DisplayName: string
  Title: Attribute Name

  Read Only: true

  Maximum Length: 30

  The promotion attribute display name that is displayed on the UI. There is no default value, dependency, or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyAttrdefnBId: integer (int64)
  Title: Attribute Definition ID

  Read Only: true

  The primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• LoyAttrItmId: integer (int64)
  Title: Loyalty Attribute Item ID

  The primary key of loyalty attribute items. There is no default value, dependency, or limitation associated with this attribute.
• LoyBucketId: integer (int64)
  Title: Loyalty Milestone ID

  Read Only: true

  The primary key value of the loyalty bucket. Oracle Loyalty Cloud generates this attribute value when a bucket attribute is created. There is no default value, dependency, or limitation associated with this attribute.
• LoyPromoId: integer (int64)
  Title: Loyalty Promotion ID

  Read Only: true

  The primary key of loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• Name: string
  Title: Promotion

  Read Only: true

  Maximum Length: 50

  The attribute indicates name of the promotion. There is no default value, dependency, or limitation associated with this attribute.
• ObjectCode: string
  Title: Object Code

  Read Only: true

  Maximum Length: 30

  The details of the object whose attribute is compared. The picklist displays only those objects that are appropriate to the value in the Rule Applies To field. The accepted values are Transaction, Member, and so on. There is no default value, dependency, or limitation associated with this attribute.
• ProcessedDt: string (date-time)
  Title: Processed Date

  Read Only: true

  The attribute indicates the date of processing of bucket attribute. There is no default value, dependency or limitation associated with this attribute.
• ProcessingComment: string
  Title: Comments

  Read Only: true

  Maximum Length: 1000

  The bucket processing comment that provides the details of an error, if any occurred during processing. There is no default value, dependency, or limitation associated with this attribute.
• PromoBucketId: integer (int64)
  Title: Promotion Bucket ID

  The promotion attribute bucket identifier. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• PromotionId: integer (int64)
  Title: Promotion ID

  Read Only: true

  The promotion attribute of the loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• Status: string
  Title: Status Meaning

  Read Only: true

  Maximum Length: 80

  The attribute represents the list of value meaning for promotion attribute Status code and indicates the status of the promotion bucket transaction. The accepted values are: Completed, In Progress, Updated, and so on. There is no default value, dependency, or limitation associated with this attribute.
• StatusCode: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  The attribute indicates the status of the bucket transaction. The accepted values are ORA_BUCKET_STATUS_COMPLETED, and so on. There is no default value, dependency, or limitation associated with this attribute.
• TransactionId: integer (int64)
  Title: Transaction ID

  The primary key from transactions which is a foreign key for promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• Value: string
  Title: Attribute Value

  Maximum Length: 250

  The value of the promotion or program attribute item. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "ProcessingComment":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "description":"The bucket processing comment that provides the details of an error, if any occurred during processing. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The attribute represents the list of value meaning for promotion attribute Status code and indicates the status of the promotion bucket transaction. The accepted values are: Completed, In Progress, Updated, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionId":{
            "title":"Promotion ID",
            "type":"integer",
            "description":"The promotion attribute of the loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LoyBucketId":{
            "title":"Loyalty Milestone ID",
            "type":"integer",
            "description":"The primary key value of the loyalty bucket. Oracle Loyalty Cloud generates this attribute value when a bucket attribute is created. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LoyPromoId":{
            "title":"Loyalty 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":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PromoBucketId":{
            "title":"Promotion Bucket ID",
            "type":"integer",
            "description":"The promotion attribute bucket identifier. 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 promotion attribute type code. This attribute reflects the type of attribute, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttrDefnId":{
            "title":"Attribute Definition ID",
            "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,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":30,
            "type":"string",
            "description":"The details of the object whose attribute is compared. The picklist displays only those objects that are appropriate to the value in the Rule Applies To field. The accepted values are Transaction, Member, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The attribute indicates the status of the bucket transaction. The accepted values are ORA_BUCKET_STATUS_COMPLETED, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LoyAttrItmId":{
            "title":"Loyalty Attribute Item ID",
            "type":"integer",
            "description":"The primary key of loyalty attribute items. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttribDefnId":{
            "title":"Attribute Definition ID",
            "type":"integer",
            "description":"The attribute definition identifier that results from transaction processing. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Promotion",
            "maxLength":50,
            "type":"string",
            "description":"The attribute indicates name of the promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"The primary key from transactions which is a foreign key for 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
        },
        "Active":{
            "title":"Active",
            "maxLength":1,
            "type":"string",
            "description":"The promotion attribute active flag. This attribute is a boolean flag that indicates whether the promotion attribute is active or not. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "BucketUid":{
            "title":"Alternate Loyalty Milestone ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique key to identify a bucket record. This attribute is automatically generated by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LoyAttrdefnBId":{
            "title":"Attribute Definition ID",
            "type":"integer",
            "description":"The primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Attribute Name",
            "maxLength":30,
            "type":"string",
            "description":"The promotion attribute display name that is displayed on the UI. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Attribute Value",
            "maxLength":250,
            "type":"string",
            "description":"The value of the promotion or program attribute item. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionNote":{
            "title":"Action Note",
            "maxLength":1000,
            "type":"string",
            "description":"The attribute indicates additional information pertaining to an action that resulted in the creation of the promotion attribute. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DataType":{
            "title":"Data Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The promotion attribute data type name indicates whether the attribute is a string, or a number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProcessedDt":{
            "title":"Processed Date",
            "type":"string",
            "description":"The attribute indicates the date of processing of bucket attribute. There is no default value, dependency or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataTypeCode":{
            "title":"Data Type",
            "maxLength":30,
            "type":"string",
            "description":"The promotion attribute data type name indicates whether the attribute is a string, or a number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top