Jump to

• Request
• Response

Get a promotion attribute

get

/crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/PromotionAttributeDetail/{PromotionAttributeDetailUniqID}

Request

Path Parameters

• MemberNumber(required): string
  The member number. This attribute is an alternative identifier for a loyalty member and is displayed in the UI. There is no default value, dependency, or limitation associated with this attribute.
• PromotionAttributeDetailUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Promotion Attribute Details resource and used to uniquely identify an instance of Promotion Attribute Details. The client should not generate the hash key value. Instead, the client should query on the Promotion Attribute Details collection resource in order to navigate to a specific instance of Promotion Attribute Details 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 : loyMembers-PromotionAttributeDetail-item-response

Type: object

Show Source

• ActionNote: string
  Title: Action Note

  Read Only: true

  Maximum Length: 1000

  The message written by an engine action when Oracle Loyalty Cloud updates the Member Promotion attribute. There is no default value, dependency, or limitation associated with this attribute.
• DisplayName: string
  Title: Attribute Name

  Read Only: true

  Maximum Length: 255

  The member promotion attribute name. This attribute is a child resource for the member, which contains the value of the promotion specific attributes for this particular member, if any. 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.
• MemberId: integer (int64)
  Read Only: true

  The primary key identifier for the loyalty member by whom the transaction has updated the Promotion attribute for the member. There is no default value, dependency, or limitation associated with this attribute.
• Name: string
  Title: Promotion

  Read Only: true

  Maximum Length: 255

  The promotion name that shows the information regarding the loyalty promotion for which the promotion level attributes have been applied by the Oracle Loyalty Cloud engine. There is no default value, dependency, or limitation associated with this attribute.
• ProcessedDt: string (date-time)
  Title: Processed Date

  Read Only: true

  The date when the promotion attribute is processed. When the Oracle Loyalty Cloud engine initiates bucket processing, it sets the date when it updates the promotion attributes. There is no default value, dependency, or limitation associated with this attribute.
• ProcessingComment: string
  Title: Comments

  Read Only: true

  Maximum Length: 255

  The transaction processing comments when the promotion attribute is updated. There is no default value, dependency, or limitation associated with this attribute.
• PromotionId: integer (int64)
  Read Only: true

  The primary key identifier of the loyalty promotion for which the promotion attribute is defined. There is no default value, dependency, or limitation associated with this attribute.
• Status: string
  Read Only: true

  Maximum Length: 80

  The status of the promotion attribute, which indicates whether this attribute is active or not. There is no default value, dependency, nor limitation associated with this attribute.
• StatusCode: string
  Title: Status

  Read Only: true

  Maximum Length: 255

  The promotion attribute status that shows the status of processing of the bucket attributes by the Oracle Loyalty Cloud engine. The corresponding finder lookup type is ORA_LOY_PROMO_BUCKET_STATUS. There is no default value, dependency, or limitation associated with this attribute.
• Value: string
  Title: Attribute Value

  Read Only: true

  Maximum Length: 250

  The promotion attribute value after the Oracle Loyalty Cloud engine updates the promotion level attribute value through bucket processing or by applying loyalty promotions which updates the value of the attribute. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":"80",
            "type":"string",
            "description":"The status of the promotion attribute, which indicates whether this attribute is active or not. There is no default value, dependency, nor limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessingComment":{
            "title":"Comments",
            "maxLength":"255",
            "type":"string",
            "description":"The transaction processing comments when the promotion attribute is updated. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberId":{
            "type":"integer",
            "description":"The primary key identifier for the loyalty member by whom the transaction has updated the Promotion attribute for the member. 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
        },
        "PromotionId":{
            "type":"integer",
            "description":"The primary key identifier of the loyalty promotion for which the promotion attribute is defined. 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":"255",
            "type":"string",
            "description":"The member promotion attribute name. This attribute is a child resource for the member, which contains the value of the promotion specific attributes for this particular member, if any. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Attribute Value",
            "maxLength":"250",
            "type":"string",
            "description":"The promotion attribute value after the Oracle Loyalty Cloud engine updates the promotion level attribute value through bucket processing or by applying loyalty promotions which updates the value of the attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionNote":{
            "title":"Action Note",
            "maxLength":"1000",
            "type":"string",
            "description":"The message written by an engine action when Oracle Loyalty Cloud updates the Member Promotion attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"255",
            "type":"string",
            "description":"The promotion attribute status that shows the status of processing of the bucket attributes by the Oracle Loyalty Cloud engine. The corresponding finder lookup type is ORA_LOY_PROMO_BUCKET_STATUS. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProcessedDt":{
            "title":"Processed Date",
            "type":"string",
            "description":"The date when the promotion attribute is processed. When the Oracle Loyalty Cloud engine initiates bucket processing, it sets the date when it updates the promotion attributes. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Promotion",
            "maxLength":"255",
            "type":"string",
            "description":"The promotion name that shows the information regarding the loyalty promotion for which the promotion level attributes have been applied by the Oracle Loyalty Cloud engine. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "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