Jump to

• Request
• Response

Get a member tier attribute

get

/crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/MemberTierAttributes/{MemberTierAttributesUniqID}

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.
• MemberTierAttributesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Member Tier Attributes resource and used to uniquely identify an instance of Member Tier Attributes. The client should not generate the hash key value. Instead, the client should query on the Member Tier Attributes collection resource in order to navigate to a specific instance of Member Tier Attributes 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(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-MemberTierAttributes-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the created member tier attribute is enabled for use or not. The default value is N. There is no dependency or limitation associated with this attribute.
• AttrTypeCode: string
  Title: Attribute Type Code

  Maximum Length: 30

  Default Value: Field

  The member tier attribute type code. This attribute reflects the type of the attribute, for example, Field, Point Total, and so on. 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 member tier attribute data type indicates whether the attribute is a string, or a number, and so on. During a 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 the String and Number data types, and the Leave As Is action is available for all data types. There is no default value or limitation associated with this attribute.
• DataTypeCode: string
  Title: Data Type

  Maximum Length: 30

  The member tier 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 the 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.
• DescriptionText: string
  Title: Description

  Maximum Length: 1000

  The additional information pertaining to the member tier attribute. There is no default value, dependency, or limitation associated with this attribute.
• DisplayName: string
  Title: Name

  Maximum Length: 30

  The member tier attribute display name is what gets displayed on the UI. There is no default value, dependency, or limitation associated with this attribute.
• InternalName: string
  Title: Field

  Maximum Length: 75

  The member tier attribute internal name. The accepted values are Date1 or Number1. 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

  Default Value: Member Tier

  The option to select values from entities such as 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 member tier attribute pick applet is a field whose values are entered using a dialog box. When defining criteria and actions, 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 member tier 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 member tier attribute pick list is enabled if the attribute is a field whose values are entered using a picklist. When 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.
• ProgramName: string
  Read Only: true

  The program for which the member tier attribute is created. There is no default value, dependency, or limitation associated with this attribute.
• ReadonlyFlag: boolean
  Title: Read Only

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the member tier attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "DefaultVal":{
            "title":"Default Value",
            "maxLength":75,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PickApplet":{
            "title":"Pick Applet",
            "maxLength":75,
            "type":"string",
            "description":"The member tier attribute pick applet is a field whose values are entered using a dialog box. When defining criteria and actions, the dialog box with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttrTypeCode":{
            "title":"Attribute Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The member tier attribute type code. This attribute reflects the type of the attribute, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":"Field",
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":30,
            "type":"string",
            "description":"The option to select values from entities such as Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":"Member Tier",
            "x-queryable":true
        },
        "InternalName":{
            "title":"Field",
            "maxLength":75,
            "type":"string",
            "description":"The member tier attribute internal name. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramName":{
            "type":"string",
            "description":"The program for which the member tier attribute is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the created member tier attribute is enabled for use or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PickFieldName":{
            "title":"Pick Field Name",
            "maxLength":75,
            "type":"string",
            "description":"The member tier 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.",
            "nullable":true,
            "x-queryable":true
        },
        "PickField":{
            "title":"Pick Field",
            "maxLength":75,
            "type":"string",
            "description":"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.",
            "nullable":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,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The member tier attribute display name is what gets displayed on the UI. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ReadonlyFlag":{
            "title":"Read Only",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the member tier attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "DataType":{
            "title":"Data Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The member tier attribute data type indicates whether the attribute is a string, or a number, and so on. During a 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 the String and Number data types, and the Leave As Is action is available for all data types. There is no default value or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_TYPE":"Y"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PickList":{
            "title":"Pick List",
            "maxLength":75,
            "type":"string",
            "description":"The member tier attribute pick list is enabled if the attribute is a field whose values are entered using a picklist. When 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.",
            "nullable":true,
            "x-queryable":true
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The additional information pertaining to the member tier attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DataTypeCode":{
            "title":"Data Type",
            "maxLength":30,
            "type":"string",
            "description":"The member tier 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 the 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,
            "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