REST API Services for CPQ Cloud

Get All Eligibility Rule Conditions

get

/rest/v7/eligibilityRule/{id}/condition

This operation retrieves all conditions for an Eligibility Rule

Request

Path Parameters

id: integer

The primary key of the Eligibility Rule

Query Parameters

fields(optional): string

Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
limit(optional): integer

The requested page size, which limits the number of elements the collection should max return.
offset(optional): integer

The offset of the page. By default, offset is 0, which means first page will be returned.
orderby(optional): string

Specifies a comma-separated list of pairs to order the response by.
q(optional): string

Allows to specify one or more filtering criteria. By default, no filtering is applied.
totalResults(optional): boolean

Specifies that the total count of records should be included in the response when doing pagination.

Response

Default Response

Root Schema : eligibilityRuleCondition-collection

Type: object

Show Source

count(optional): integer

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

Returns true if more resources are available on the server than the subset returned in current page.
items(optional): array items
limit(optional): integer

The actual paging size used by the server.
offset(optional): integer

The offset used in the current page.
totalResults(optional): integer

Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/eligibilityRuleCondition"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object Eligibility Rule Condition

Title: Eligibility Rule Condition

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/eligibilityRuleCondition"
    }
}

Nested Schema : Eligibility Rule Condition

Type: object

Title: Eligibility Rule Condition

Show Source

attributeName(optional): string

Title: attributeName

Data source field for condition is stored in this field
dataType(optional): object dataType

Title: dataType

Indicates data type of attributeName
dateAdded(optional): string

Title: dateAdded

date on which this record is added
dateModified(optional): string

Title: dateModified
id(optional): integer

Title: id
operator(optional): object operator

Title: operator

opearator for condition is stored in this field
ruleConditionIndex(optional): integer

Title: ruleConditionIndex

row index of Rule condition
ruleId(optional): object ruleId

Title: ruleId

Foreign key field
value(optional): string

Title: value

value for condition is stored in this field

{
    "type":"object",
    "properties":{
        "attributeName":{
            "type":"string",
            "description":"Data source field for condition is stored in this field",
            "title":"attributeName"
        },
        "dataType":{
            "type":"object",
            "description":"Indicates data type of attributeName",
            "title":"dataType",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "dateAdded":{
            "type":"string",
            "description":"date on which this record is added",
            "title":"dateAdded"
        },
        "dateModified":{
            "type":"string",
            "description":"",
            "title":"dateModified"
        },
        "id":{
            "type":"integer",
            "description":"",
            "title":"id"
        },
        "operator":{
            "type":"object",
            "description":"opearator for condition is stored in this field",
            "title":"operator",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "ruleConditionIndex":{
            "type":"integer",
            "description":"row index of Rule condition",
            "title":"ruleConditionIndex"
        },
        "ruleId":{
            "type":"object",
            "description":"Foreign key field",
            "title":"ruleId",
            "properties":{
                "id":{
                    "type":"integer",
                    "description":"Primary key of BM_Eligibility_rule",
                    "title":"id"
                },
                "variableName":{
                    "type":"string",
                    "description":"variable name of Eligibility Rule",
                    "title":"variableName"
                }
            }
        },
        "value":{
            "type":"string",
            "description":"value for condition is stored in this field",
            "title":"value"
        }
    },
    "title":"Eligibility Rule Condition"
}

Nested Schema : dataType

Type: object

Title: dataType

Indicates data type of attributeName

Show Source

displayValue(optional): string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
id(optional): integer

Title: Id

Primary Key of the fixed list of value resource.
lookupCode(optional): string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Indicates data type of attributeName",
    "title":"dataType",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : operator

Type: object

Title: operator

opearator for condition is stored in this field

Show Source

displayValue(optional): string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
id(optional): integer

Title: Id

Primary Key of the fixed list of value resource.
lookupCode(optional): string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"opearator for condition is stored in this field",
    "title":"operator",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : ruleId

Type: object

Title: ruleId

Foreign key field

Show Source

id(optional): integer

Title: id

Primary key of BM_Eligibility_rule
variableName(optional): string

Title: variableName

variable name of Eligibility Rule

{
    "type":"object",
    "description":"Foreign key field",
    "title":"ruleId",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Primary key of BM_Eligibility_rule",
            "title":"id"
        },
        "variableName":{
            "type":"string",
            "description":"variable name of Eligibility Rule",
            "title":"variableName"
        }
    }
}