Jump to

• Request
• Response

Get All BOM Mapping Rule Conditions

get

/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/bomMappingRules/{ruleId}/conditions

Use this endpoint to retrieve a list of conditions for the specified BOM Mapping Rule.

Request

Supported Media Types

• application/json

Path Parameters

• modelVarName(required): string
  Variable Name of the Model.
• prodFamVarName(required): string
  Variable Name of the Product Family.
• prodLineVarName(required): string
  Variable Name of the Product Line
• ruleId(required): integer
  The Configuration rule Id.
• varName(required): string
  Variable Name of All Product Families '_allProductFamilies'

Query Parameters

• fields: string
  Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
• limit: integer
  The requested page size, which limits the number of elements the collection should max return.
• offset: integer
  The offset of the page. By default, offset is 0, which means first page will be returned.
• orderby: string
  Specifies a comma-separated list of pairs to order the response by.
• q: string
  Allows to specify one or more filtering criteria. By default, no filtering is applied.
• totalResults: boolean
  Specifies that the total count of records should be included in the response when doing pagination.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : configRuleConditionSetups-collection

Type: object

Show Source

• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Returns true if more resources are available on the server than the subset returned in current page.
• items: array items
• limit: integer
  The actual paging size used by the server.
• offset: integer
  The offset used in the current page.
• totalResults: 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/configRuleConditionSetups"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Config Rule Condition
  Title: Config Rule Condition

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

Nested Schema : Config Rule Condition

Type: object

Title: Config Rule Condition

Show Source

• attributeId: integer
  Title: Attribute Id

  Id of the Attribute
• dateAdded: string
  Title: Date Added

  System field indicating the date on which the Resource was created.
• dateModified: string
  Title: Date Modified

  System field indicating the date on which the Resource was last modified.
• id: integer
  Title: Id

  Primary Key Of The Resource
• operator1: object Operator 1
  Title: Operator 1

  Operator 1 of The Condition
• operator2: object Operator 2
  Title: Operator 2

  Operator 2 of The Condition
• ruleConditionIndex: integer
  Title: Rule Condition Index

  Unique Index of Rule Condition
• ruleId: integer
  Title: Rule Id

  Id of the Rule
• value1: string
  Title: Value 1

  Value 1 of the Condition
• value2: string
  Title: Value 2

  Value 2 of the Condition

{
    "type":"object",
    "properties":{
        "attributeId":{
            "type":"integer",
            "description":"Id of the Attribute",
            "title":"Attribute Id"
        },
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key Of The Resource",
            "title":"Id"
        },
        "operator1":{
            "type":"object",
            "description":"Operator 1 of The Condition",
            "title":"Operator 1",
            "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"
                }
            }
        },
        "operator2":{
            "type":"object",
            "description":"Operator 2 of The Condition",
            "title":"Operator 2",
            "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":"Unique Index of Rule Condition",
            "title":"Rule Condition Index"
        },
        "ruleId":{
            "type":"integer",
            "description":"Id of the Rule",
            "title":"Rule Id"
        },
        "value1":{
            "type":"string",
            "description":"Value 1 of the Condition",
            "title":"Value 1"
        },
        "value2":{
            "type":"string",
            "description":"Value 2 of the Condition",
            "title":"Value 2"
        }
    },
    "title":"Config Rule Condition"
}

Nested Schema : Operator 1

Type: object

Title: Operator 1

Operator 1 of The Condition

Show Source

• displayValue: string
  Title: Display Value

  Translated display name of the type for which fixed list of values can be defined.
• id: integer
  Title: Id

  Primary Key of the fixed list of value resource.
• lookupCode: string
  Title: Lookup Code

  Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Operator 1 of The Condition",
    "title":"Operator 1",
    "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 2

Type: object

Title: Operator 2

Operator 2 of The Condition

Show Source

• displayValue: string
  Title: Display Value

  Translated display name of the type for which fixed list of values can be defined.
• id: integer
  Title: Id

  Primary Key of the fixed list of value resource.
• lookupCode: string
  Title: Lookup Code

  Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Operator 2 of The Condition",
    "title":"Operator 2",
    "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"
        }
    }
}

Back to Top