REST API for Oracle Loyalty Cloud

Get all negative points

get

/crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/NegativePoints

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.

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
finder: string
Used as a predefined finder to search the collection.

Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

The following are the available finder names and corresponding finder variables:
- PrimaryKey: Finds the negative points with the specified program negative point identifier.
  Finder Variables:
  - ProgNegPointId; integer; The program negative point identifier.
limit: integer

This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
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
offset: integer

Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).
orderBy: string

This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

Format: ?q=expression1;expression2

You can use these queryable attributes to filter this collection resource using the q query parameter:
- AbsoluteValue; number; The attribute represents the absolute value of a negative points record. There is no default value, dependency, or limitation associated with this attribute.
- Basis; string; The attribute indicates the basis meaning of a negative points record. It can have either of two values as 'maximum' or 'minimum'. There is no default value, dependency, or limitation associated with this attribute.
- BasisCd; string; The attribute indicates the basis code meaning of a negative points record. It can have either of two values as 'maximum' or 'minimum'. There is no default value, dependency, or limitation associated with this attribute.
- CreatedBy; string; The loyalty user that created the negative points record. Oracle Loyalty Cloud generates this attribute value during the creation of a new negative points record. There is no default value, dependency, or limitation associated with this attribute.
- CreationDate; string; The date when the negative points record is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new negative points record. There is no default value, dependency, or limitation associated with this attribute.
- LastUpdateDate; string; The date when the negative points record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to negative points occur. There is no default value, dependency, or limitation associated with this attribute.
- LastUpdateLogin; string; The login details of the user that last updated the negative points record. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the negative points occur. There is no default value, dependency, or limitation associated with this attribute.
- LastUpdatedBy; string; The user that last updated the negative points. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes happen to the negative points. There is no default value, dependency, or limitation associated with this attribute.
- PointBalancePercentage; number; This attribute shows the negative points allowed to a member as percentage of the point balance available. There is no any default value to it.
- PointTypeId; integer; The attribute is the unique point type identifier corresponding to the point type selected in a negative points record. There is no default value, dependency, or limitation associated with this attribute.
- ProgNegPointId; integer; The primary key of the loyalty negative points record. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
- ProgramName; string; The program for which the negative points record is created. There is no default value, dependency, or limitation associated with this attribute.
- TierClassId; integer; The attribute is the unique tier class identifier corresponding to the tier class selected in a negative points record. There is no default value, dependency, or limitation associated with this attribute.
- TierId; integer; The attribute is the unique tier identifier corresponding to the tier name selected in a negative points record. There is no default value, dependency, or limitation associated with this attribute.
totalResults: boolean

The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

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.

Root Schema : loyPrograms-NegativePoints

Type: object

Show Source

count(required): integer

The number of resource instances returned in the current range.
hasMore(required): boolean

Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
items: array Items

Title: Items

The items in the collection.
limit(required): integer

The actual paging size used by the server.
links(required): array Links

Title: Links

The link relations associated with the resource instance.
offset(required): integer

The offset value used in the current page.
totalResults: integer

The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/loyPrograms-NegativePoints-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object loyPrograms-NegativePoints-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/loyPrograms-NegativePoints-item-response"
    }
}

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 : loyPrograms-NegativePoints-item-response

Type: object

Show Source

AbsoluteValue: number

Title: Absolute Value

The attribute represents the absolute value of a negative points record. There is no default value, dependency, or limitation associated with this attribute.
Basis: string

Title: Basis Meaning

Read Only: true

Maximum Length: 80

The attribute indicates the basis meaning of a negative points record. It can have either of two values as 'maximum' or 'minimum'. There is no default value, dependency, or limitation associated with this attribute.
BasisCd: string

Title: Basis

Maximum Length: 30

The attribute indicates the basis code meaning of a negative points record. It can have either of two values as 'maximum' or 'minimum'. 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 negative points record. Oracle Loyalty Cloud generates this attribute value during the creation of a new negative points record. There is no default value, dependency, or limitation associated with this attribute.
CreationDate: string (date-time)

Read Only: true

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

Read Only: true

The date when the negative points record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to negative points 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 negative points. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes happen to the negative points. There is no default value, dependency, or limitation associated with this attribute.
LastUpdateLogin: string

Read Only: true

Maximum Length: 32

The login details of the user that last updated the negative points record. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the negative points occur. 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.
PointBalancePercentage: number

Title: Percentage

This attribute shows the negative points allowed to a member as percentage of the point balance available. There is no any default value to it.
PointTypeId: integer (int64)

Title: Point Type

The attribute is the unique point type identifier corresponding to the point type selected in a negative points record. There is no default value, dependency, or limitation associated with this attribute.
PointTypeName: string

The attribute indicates the name of the point type which is added for negative points. There is no default value, dependency, or limitation associated with this attribute.
ProgNegPointId: integer (int64)

The primary key of the loyalty negative points record. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
ProgramName: string

Title: Program

Read Only: true

Maximum Length: 50

The program for which the negative points record is created. There is no default value, dependency, or limitation associated with this attribute.
TierClassId: integer (int64)

Title: Tier Class

The attribute is the unique tier class identifier corresponding to the tier class selected in a negative points record. There is no default value, dependency, or limitation associated with this attribute.
TierClassName: string

The attribute that indicates the name of the tier class with which the negative points record is created. There is no default value, dependency, or limitation associated with this attribute.
TierId: integer (int64)

Title: Tier

The attribute is the unique tier identifier corresponding to the tier name selected in a negative points record. There is no default value, dependency, or limitation associated with this attribute.
TierName: string

The attribute that indicates the name of the tier associated with a negative points record. 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 negative points. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes happen to the negative points. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the negative points record is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new negative points record. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AbsoluteValue":{
            "title":"Absolute Value",
            "type":"number",
            "description":"The attribute represents the absolute value of a negative points record. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The loyalty user that created the negative points record. Oracle Loyalty Cloud generates this attribute value during the creation of a new negative points record. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TierClassName":{
            "type":"string",
            "description":"The attribute that indicates the name of the tier class with which the negative points record is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "PointTypeName":{
            "type":"string",
            "description":"The attribute indicates the name of the point type which is added for negative points. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "ProgramName":{
            "title":"Program",
            "maxLength":50,
            "type":"string",
            "description":"The program for which the negative points record is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PointTypeId":{
            "title":"Point Type",
            "type":"integer",
            "description":"The attribute is the unique point type identifier corresponding to the point type selected in a negative points record. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "Basis":{
            "title":"Basis Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The attribute indicates the basis meaning of a negative points record. It can have either of two values as 'maximum' or 'minimum'. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_TYPE":"Y"
            },
            "x-queryable":true
        },
        "TierId":{
            "title":"Tier",
            "type":"integer",
            "description":"The attribute is the unique tier identifier corresponding to the tier name selected in a negative points record. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "PointBalancePercentage":{
            "title":"Percentage",
            "type":"number",
            "description":"This attribute shows the negative points allowed to a member as percentage of the point balance available. There is no any default value to it.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgNegPointId":{
            "type":"integer",
            "description":"The primary key of the loyalty negative points record. 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
        },
        "BasisCd":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The attribute indicates the basis code meaning of a negative points record. It can have either of two values as 'maximum' or 'minimum'. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TierClassId":{
            "title":"Tier Class",
            "type":"integer",
            "description":"The attribute is the unique tier class identifier corresponding to the tier class selected in a negative points record. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "TierName":{
            "type":"string",
            "description":"The attribute that indicates the name of the tier associated with a negative points record. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "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 negative points record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to negative points occur. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last updated the negative points record. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the negative points occur. 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."
        }
    }
}