Jump to

• Request
• Response

Get a partner terms attribute

get

/crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/ProgramPartners/{LoyProgOrgId}/child/PartnerTermsAttributes/{ProgPartnerPnttypeId}

Request

Path Parameters

• LoyProgOrgId(required): integer(int64)
  The organization identifier of the program partner. 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.
• ProgPartnerPnttypeId(required): integer(int64)
  The partner point type detail from the partner term attribute for the partner. 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 : loyPrograms-ProgramPartners-PartnerTermsAttributes-item-response

Type: object

Show Source

• ConvRate: number
  Title: Conversion Rate

  The conversion rate defined for the partner in the partner term attribute. 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 partner term attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new partner term attribute. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Read Only: true

  The date when the partner term attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new partner term attribute record. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the partner term attribute record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the partner term 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 partner term attribute. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the partner term attribute. There is no 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. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the partner term attribute. There is no dependency or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PointTypeId: integer (int64)
  Title: Point Type

  The point type identifier, which uniquely identifies each point type. Various point types are defined to reward and recognize members based on their activities, such as, completing a flight or referring a friend to the program. Some point types are defined to allow members to redeem points for a product or service, while some are defined to track their behavior and reward them by assigning a new tier status. There is no default value, dependency, or limitation associated with this attribute.
• PointTypeName: string
  The name of the point type. This is also a parameter in the redemptionProductsFinder finder. If the value is not provided, this attribute lists ProdRedemptionPoint for all possible point types in a given program name. There is no dependency or limitation associated with this attribute.
• ProgPartnerId: integer (int64)
  The partner identifier. There is no default value, dependency, or limitation associated with this attribute.
• ProgPartnerPnttypeId: integer (int64)
  The partner point type detail from the partner term attribute for the partner. 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 partner term attribute. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the partner term attribute. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the partner term attribute is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new partner term attribute record. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The loyalty user that created the partner term attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new partner term attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProgPartnerId":{
            "type":"integer",
            "description":"The partner identifier. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ConvRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"The conversion rate defined for the partner in the partner term attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PointTypeName":{
            "type":"string",
            "description":"The name of the point type. This is also a parameter in the redemptionProductsFinder finder. If the value is not provided, this attribute lists ProdRedemptionPoint for all possible point types in a given program name. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "ProgPartnerPnttypeId":{
            "type":"integer",
            "description":"The partner point type detail from the partner term attribute for the partner. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the partner term attribute record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the partner term attribute record occur. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last logged in. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the partner term attribute. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PointTypeId":{
            "title":"Point Type",
            "type":"integer",
            "description":"The point type identifier, which uniquely identifies each point type. Various point types are defined to reward and recognize members based on their activities, such as, completing a flight or referring a friend to the program. Some point types are defined to allow members to redeem points for a product or service, while some are defined to track their behavior and reward them by assigning a new tier status. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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