Performs a load arrayset data action for the given arraySetName in the input payload

post

/ccstore/v1/cpq/configurations/arraySets/fetch

This endpoint performs load arrayset data action for a particular configuration

Request

Supported Media Types
Body ()
Root Schema : ArraySetGetRequestBody
Type: object
Show Source
Example:
{
    "productFamily":"laptop",
    "productLine":"laptopConfiguration",
    "arraySetVarName":"_setarraySetSSM1",
    "cacheInstanceId":"LDYHzmkorOrX3Qg9xUnV4I21LR35O7E3hyP45UrWUYFchcbLIc7xH5f4EVTiIYQx",
    "model":"sku50001"
}
Nested Schema : criteria
Type: object
This is being used as filter to be used on the CPQ payload
Show Source
  • In case the state is passed as true, the state of the configurable attributes is returned in the response. Otherwise the state of the configurable attributes is not returned in the response.
Back to Top

Response

Supported Media Types

200 Response

Updated items response for the getArraySet
Body ()
Root Schema : LoadArraySetDataResponse
Example:
{
    "configData":{
        "_recmdModels":{
            "items":[
            ]
        },
        "hTMLAttribute":"<br /><br />This is sample formatted test.<br /><strong>This is bold<br /></strong><span style=\"text-decoration: underline;\">Underline<br /><br /></span>Hoooo a <a href=\"http://google.com\" target=\"_blank\">link!<br /></a>",
        "_bom":{
            "items":[
            ]
        },
        "_mandatoryModels":{
            "items":[
            ]
        },
        "_state":{
            "updatable":true,
            "messages":[
            ],
            "attributes":{
                "hTMLAttribute":{
                    "hasConstraintViolation":false,
                    "visible":true,
                    "updatable":false,
                    "messages":[
                    ],
                    "hasError":false
                },
                "arrayControl1":{
                    "recommendationMessages":[
                    ],
                    "hasConstraintViolation":false,
                    "visible":true,
                    "updatable":true,
                    "messages":[
                    ],
                    "hasError":false,
                    "hasWarning":false
                },
                "arrayControl2":{
                    "recommendationMessages":[
                    ],
                    "hasConstraintViolation":false,
                    "visible":true,
                    "updatable":true,
                    "messages":[
                    ],
                    "hasError":false,
                    "hasWarning":false
                },
                "_isMainModelSelected":{
                    "recommendationMessages":[
                    ],
                    "hasConstraintViolation":false,
                    "visible":false,
                    "updatable":true,
                    "messages":[
                    ],
                    "hasError":false,
                    "hasWarning":false
                },
                "imageMenu":{
                    "recommendationMessages":[
                    ],
                    "hasConstraintViolation":false,
                    "visible":true,
                    "domain":{
                        "constraintType":"DISALLOWED",
                        "constraintList":[
                        ],
                        "domainRestricted":true,
                        "availableElements":[
                            {
                                "displayValue":"Image 1",
                                "value":"Image 1"
                            },
                            {
                                "displayValue":"Image 2",
                                "value":"Image 2"
                            },
                            {
                                "displayValue":"Image 3",
                                "value":"Image 3"
                            }
                        ]
                    },
                    "updatable":true,
                    "messages":[
                    ],
                    "hasError":false,
                    "hasWarning":false,
                    "required":false
                }
            },
            "hasError":false,
            "hasWarning":false,
            "actions":{
                "_startOver":{
                    "visible":true,
                    "enabled":true
                },
                "_cancel":{
                    "visible":false,
                    "enabled":true
                },
                "_addToTxn":{
                    "visible":false,
                    "enabled":true
                },
                "_cm_36292358":{
                    "visible":true,
                    "enabled":true
                },
                "_update":{
                    "visible":true,
                    "enabled":true
                },
                "_integration_addToCart":{
                    "visible":true,
                    "enabled":true
                },
                "_save":{
                    "visible":false,
                    "enabled":true
                },
                "_next":{
                    "visible":false,
                    "enabled":true
                },
                "_previous":{
                    "visible":true,
                    "enabled":true
                }
            }
        },
        "arrayControl1":1,
        "arrayControl2":3,
        "_mandatoryParts":{
            "items":[
            ]
        },
        "_setset1":{
            "totalResults":1,
            "offset":0,
            "_state":{
                "defaultRowState":{
                    "updatable":true,
                    "messages":[
                    ],
                    "attributes":{
                        "arrayFloatField1":{
                            "recommendationMessages":[
                            ],
                            "hasConstraintViolation":false,
                            "visible":true,
                            "updatable":true,
                            "messages":[
                            ],
                            "hasError":false,
                            "hasWarning":false
                        },
                        "arrayBoolean1":{
                            "recommendationMessages":[
                            ],
                            "hasConstraintViolation":false,
                            "visible":true,
                            "updatable":true,
                            "messages":[
                            ],
                            "hasError":false,
                            "hasWarning":false
                        },
                        "arrayTextField1":{
                            "recommendationMessages":[
                            ],
                            "hasConstraintViolation":false,
                            "visible":true,
                            "updatable":true,
                            "messages":[
                            ],
                            "hasError":false,
                            "hasWarning":false
                        },
                        "arrayCurrencyField1":{
                            "recommendationMessages":[
                            ],
                            "hasConstraintViolation":false,
                            "visible":true,
                            "updatable":true,
                            "messages":[
                            ],
                            "hasError":false,
                            "hasWarning":false
                        },
                        "arrayIntegerField1":{
                            "recommendationMessages":[
                            ],
                            "hasConstraintViolation":false,
                            "visible":true,
                            "updatable":true,
                            "messages":[
                            ],
                            "hasError":false,
                            "hasWarning":false
                        },
                        "arrayDateField1":{
                            "recommendationMessages":[
                            ],
                            "hasConstraintViolation":false,
                            "visible":true,
                            "updatable":true,
                            "messages":[
                            ],
                            "hasError":false,
                            "hasWarning":false
                        }
                    },
                    "hasError":false
                },
                "deletable":true,
                "attributes":{
                    "arrayFloatField1":{
                        "visible":true
                    },
                    "arrayBoolean1":{
                        "visible":true
                    },
                    "arrayTextField1":{
                        "visible":true
                    },
                    "arrayCurrencyField1":{
                        "visible":true
                    },
                    "arrayIntegerField1":{
                        "visible":true
                    },
                    "arrayDateField1":{
                        "visible":true
                    }
                },
                "sortable":false,
                "actions":{
                    "_delete":{
                        "visible":true,
                        "enabled":true
                    },
                    "_add":{
                        "visible":true,
                        "enabled":true
                    }
                },
                "insertable":true
            },
            "limit":200,
            "count":1,
            "hasMore":false,
            "items":[
                {
                    "arrayFloatField1":null,
                    "arrayBoolean1":false,
                    "_index":0,
                    "_state":{
                        "messages":[
                        ],
                        "hasError":false
                    },
                    "arrayTextField1":"",
                    "arrayCurrencyField1":null,
                    "arrayIntegerField1":null,
                    "arrayDateField1":null,
                    "_rowKey":"b2d77c0b-4f50-40de-998e-9b04b9fcef0e"
                }
            ]
        },
        "_setset2":{
            "totalResults":3,
            "offset":0,
            "_state":{
                "defaultRowState":{
                    "updatable":true,
                    "messages":[
                    ],
                    "attributes":{
                        "arrayBoolean2":{
                            "recommendationMessages":[
                            ],
                            "hasConstraintViolation":false,
                            "visible":true,
                            "updatable":true,
                            "messages":[
                            ],
                            "hasError":false,
                            "hasWarning":false
                        },
                        "arrayFloatSSM1":{
                            "recommendationMessages":[
                            ],
                            "hasConstraintViolation":false,
                            "visible":true,
                            "domain":{
                                "constraintType":"DISALLOWED",
                                "constraintList":[
                                ],
                                "domainRestricted":true,
                                "availableElements":[
                                    {
                                        "displayValue":"1.23",
                                        "value":1.23
                                    },
                                    {
                                        "displayValue":"2.34",
                                        "value":2.34
                                    },
                                    {
                                        "displayValue":"3.45",
                                        "value":3.45
                                    }
                                ]
                            },
                            "updatable":true,
                            "messages":[
                            ],
                            "hasError":false,
                            "hasWarning":false
                        },
                        "arrayTextSSM1":{
                            "recommendationMessages":[
                            ],
                            "hasConstraintViolation":false,
                            "visible":true,
                            "domain":{
                                "constraintType":"DISALLOWED",
                                "constraintList":[
                                ],
                                "domainRestricted":true,
                                "availableElements":[
                                    {
                                        "displayValue":"Value 1",
                                        "value":"Value 1"
                                    },
                                    {
                                        "displayValue":"Value 2",
                                        "value":"Value 2"
                                    },
                                    {
                                        "displayValue":"Value 3",
                                        "value":"Value 3"
                                    }
                                ]
                            },
                            "updatable":true,
                            "messages":[
                            ],
                            "hasError":false,
                            "hasWarning":false
                        },
                        "arrayIntegerSSM1":{
                            "recommendationMessages":[
                            ],
                            "hasConstraintViolation":false,
                            "visible":true,
                            "domain":{
                                "constraintType":"DISALLOWED",
                                "constraintList":[
                                ],
                                "domainRestricted":true,
                                "availableElements":[
                                    {
                                        "displayValue":"1",
                                        "value":1
                                    },
                                    {
                                        "displayValue":"2",
                                        "value":2
                                    },
                                    {
                                        "displayValue":"3",
                                        "value":3
                                    }
                                ]
                            },
                            "updatable":true,
                            "messages":[
                            ],
                            "hasError":false,
                            "hasWarning":false
                        }
                    },
                    "hasError":false
                },
                "deletable":true,
                "attributes":{
                    "arrayBoolean2":{
                        "visible":true
                    },
                    "arrayFloatSSM1":{
                        "visible":true
                    },
                    "arrayTextSSM1":{
                        "visible":true
                    },
                    "arrayIntegerSSM1":{
                        "visible":true
                    }
                },
                "sortable":false,
                "actions":{
                    "_delete":{
                        "visible":true,
                        "enabled":true
                    },
                    "_add":{
                        "visible":true,
                        "enabled":true
                    }
                },
                "insertable":true
            },
            "limit":200,
            "count":3,
            "hasMore":false,
            "items":[
                {
                    "arrayBoolean2":false,
                    "arrayFloatSSM1":{
                        "displayValue":"",
                        "value":null
                    },
                    "_index":0,
                    "_state":{
                        "messages":[
                        ],
                        "hasError":false
                    },
                    "arrayTextSSM1":{
                        "displayValue":"",
                        "value":""
                    },
                    "arrayIntegerSSM1":{
                        "displayValue":"",
                        "value":null
                    },
                    "_rowKey":"8f54e513-27a8-4cd4-ad9c-7aab3a97da61"
                },
                {
                    "arrayBoolean2":false,
                    "arrayFloatSSM1":{
                        "displayValue":"",
                        "value":null
                    },
                    "_index":1,
                    "_state":{
                        "messages":[
                        ],
                        "hasError":false
                    },
                    "arrayTextSSM1":{
                        "displayValue":"",
                        "value":""
                    },
                    "arrayIntegerSSM1":{
                        "displayValue":"",
                        "value":null
                    },
                    "_rowKey":"2d3a23c3-baf4-45ee-9cfe-2804339b9374"
                },
                {
                    "arrayBoolean2":false,
                    "arrayFloatSSM1":{
                        "displayValue":"",
                        "value":null
                    },
                    "_index":2,
                    "_state":{
                        "messages":[
                        ],
                        "hasError":false
                    },
                    "arrayTextSSM1":{
                        "displayValue":"",
                        "value":""
                    },
                    "arrayIntegerSSM1":{
                        "displayValue":"",
                        "value":null
                    },
                    "_rowKey":"ba68683d-9b4b-4e12-951a-0605af5e2236"
                }
            ]
        },
        "_isMainModelSelected":true,
        "_priceInfo":{
            "name":"Price",
            "items":[
                {
                    "category":{
                        "code":"GENERAL",
                        "displayName":"Price"
                    },
                    "_others":[
                        {
                            "variableName":"_totalConfiguredPrice",
                            "price":{
                                "currency":"USD",
                                "value":0
                            },
                            "name":"Total Configured Price of Model"
                        }
                    ]
                }
            ]
        },
        "_recmdParts":{
            "items":[
            ]
        },
        "imageMenu":{
            "displayValue":"",
            "value":""
        }
    },
    "systemCurrentDate":"2019-08-22",
    "cacheInstanceId":"tNVGM7chHpsV6A0kd74UZCqli0V6kMlAdPCj19fC0WtIXgLmU10znN2S0LTF3jhJ"
}

400 Response

Bad request input data
Body ()
Root Schema : Error
Type: object
Show Source
Back to Top