Performs a remove arrayset row action on a arrayset.
post
/ccstore/v1/cpq/configurations/arraySets/delete
This endpoint performs a remove arrayset row action for a particular configuration
Request
Supported Media Types
- application/json
Root Schema : ArraySetDeleteRequestBody
Type:
Show Source
object
-
arraySetVarName(required):
string
The name of the arrayset that a row will be added to.
-
cacheInstanceId(required):
string
The cacheInstanceId of the configuration that the arrayset action is to be performed on.
-
criteria:
object criteria
This is being used as filter to be used on the CPQ payload
-
model(required):
string
The model to be configured.
-
productFamily(required):
string
The productFamily of the model to be configured.
-
productLine(required):
string
The productLine of the model to be configured.
-
removeIndex(required):
string
The index of the row in the arrayset that will be removed.
Example:
{
"productFamily":"test1",
"productLine":"productLine1",
"arraySetVarName":"set1",
"cacheInstanceId":"tNVGM7chHpsV6A0kd74UZCqli0V6kMlAdPCj19fC0WtIXgLmU10znN2S0LTF3jhJ",
"removeIndex":0,
"model":"model1"
}
Nested Schema : criteria
Type:
object
This is being used as filter to be used on the CPQ payload
Show Source
-
childDefs:
array childDefs
This property contains the filter value to be used at CPQ.
-
state:
boolean
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.
Nested Schema : childDefs
Type:
array
This property contains the filter value to be used at CPQ.
Show Source
Nested Schema : items
Type:
Show Source
object
-
name:
string
Name can contain the state property value that is required.
Response
Supported Media Types
- application/json
200 Response
Updated items response for a remove operation. This response is returned by a remove arrayset invocation.
Root Schema : RemoveArraySetRowResponse
Example:
{
"cacheInstanceId":"tNVGM7chHpsV6A0kd74UZCqli0V6kMlAdPCj19fC0WtIXgLmU10znN2S0LTF3jhJ",
"items":[
{
"arrayFloatField1":null,
"arrayBoolean1":false,
"_index":0,
"arrayTextField1":"",
"arrayCurrencyField1":null,
"arrayIntegerField1":null,
"arrayDateField1":null,
"_rowKey":"b2d77c0b-4f50-40de-998e-9b04b9fcef0e"
}
]
}
400 Response
Bad request input data
Root Schema : Error
Type:
Show Source
object
-
message:
string
The error message
-
status:
string
The Error code