Jump to

• Request
• Response

Performs an add arrayset row action on a arrayset.

post

/ccstore/v1/cpq/configurations/arraySets/add

This endpoint performs an add arrayset row action for a particular configuration

Request

Supported Media Types

• application/json

Body ()

Root Schema : AddArraySetRowRequest

Type: object

Show Source

• 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.

{
    "type":"object",
    "required":[
        "productFamily",
        "productLine",
        "model",
        "arraySetVarName",
        "cacheInstanceId"
    ],
    "properties":{
        "productFamily":{
            "description":"The productFamily of the model to be configured.",
            "type":"string"
        },
        "productLine":{
            "description":"The productLine of the model to be configured.",
            "type":"string"
        },
        "arraySetVarName":{
            "description":"The name of the arrayset that a row will be added to.",
            "type":"string"
        },
        "criteria":{
            "description":"This is being used as filter to be used on the CPQ payload",
            "type":"object",
            "properties":{
                "childDefs":{
                    "description":"This property contains the filter value to be used at CPQ.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "name":{
                                "description":"Name can contain the state property value that is required.",
                                "type":"string"
                            }
                        }
                    }
                },
                "state":{
                    "description":"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.",
                    "type":"boolean"
                }
            }
        },
        "cacheInstanceId":{
            "description":"The cacheInstanceId of the configuration that the arrayset action is to be performed on.",
            "type":"string"
        },
        "model":{
            "description":"The model to be configured.",
            "type":"string"
        }
    },
    "example":{
        "productFamily":"test1",
        "productLine":"productLine1",
        "arraySetVarName":"set1",
        "cacheInstanceId":"lplWwUDfomQfOCHquG1AKGbpKnqQsrw03JubE3n2bmAb6UnKBl1mrBcQ4zGypY58",
        "model":"model1"
    }
}

Example:

{
    "productFamily":"test1",
    "productLine":"productLine1",
    "arraySetVarName":"set1",
    "cacheInstanceId":"lplWwUDfomQfOCHquG1AKGbpKnqQsrw03JubE3n2bmAb6UnKBl1mrBcQ4zGypY58",
    "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.

{
    "description":"This is being used as filter to be used on the CPQ payload",
    "type":"object",
    "properties":{
        "childDefs":{
            "description":"This property contains the filter value to be used at CPQ.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"Name can contain the state property value that is required.",
                        "type":"string"
                    }
                }
            }
        },
        "state":{
            "description":"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.",
            "type":"boolean"
        }
    }
}

Nested Schema : childDefs

Type: array

This property contains the filter value to be used at CPQ.

Show Source

• Array of: object items

{
    "description":"This property contains the filter value to be used at CPQ.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"Name can contain the state property value that is required.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name: string
  Name can contain the state property value that is required.

{
    "type":"object",
    "properties":{
        "name":{
            "description":"Name can contain the state property value that is required.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Updated items response for an add operation. This response is returned by an add arrayset invocation.

Body ()

Root Schema : AddArraySetRowResponse

Example:

{
    "cacheInstanceId":"lplWwUDfomQfOCHquG1AKGbpKnqQsrw03JubE3n2bmAb6UnKBl1mrBcQ4zGypY58",
    "items":[
        {
            "arrayFloatField1":null,
            "arrayBoolean1":false,
            "_index":0,
            "arrayTextField1":"",
            "arrayCurrencyField1":null,
            "arrayIntegerField1":null,
            "arrayDateField1":null,
            "_rowKey":"b2d77c0b-4f50-40de-998e-9b04b9fcef0e"
        },
        {
            "arrayFloatField1":null,
            "arrayBoolean1":false,
            "_index":1,
            "arrayTextField1":"",
            "arrayCurrencyField1":null,
            "arrayIntegerField1":null,
            "arrayDateField1":null,
            "_rowKey":"8076cbb8-75ab-4c88-8b2e-4e35296041ce"
        }
    ]
}

400 Response

Bad request input data

Body ()

Root Schema : Error

Type: object

Show Source

• message: string
  The error message
• status: string
  The Error code

{
    "type":"object",
    "properties":{
        "message":{
            "description":"The error message",
            "type":"string"
        },
        "status":{
            "description":"The Error code",
            "type":"string"
        }
    }
}

Back to Top