Skip to content
Komplett LogoKomplett Platform

Validate compatibility configuration

POST
/v1/compatibility/configuration
curl --request POST \
  --url https://example.com/komplettpc/v1/compatibility/configuration \
  --header 'Content-Type: application/json' \
  --data '{ "products": [ { "productId": "example" } ] }'

Validates whether the given set of products form a compatible configuration.

Request Bodyrequired

Section titled “Request Bodyrequired”
object
products
required
Array<object>
object
productId
required
string
Examplegenerated
{
  "products": [
    {
      "productId": "example"
    }
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
isValid
required
boolean
invalidProducts
required
Array<string>
errors
required
Array<object>
object
ruleName
required
string
message
required
string
shortMessage
required
string
severity
required
string
relatedProducts
required
Array<string>
warnings
required
Array<object>
object
ruleName
required
string
message
required
string
shortMessage
required
string
category
required
string
relatedProducts
required
Array<string>
Examplegenerated
{
  "isValid": true,
  "invalidProducts": [
    "example"
  ],
  "errors": [
    {
      "ruleName": "example",
      "message": "example",
      "shortMessage": "example",
      "severity": "example",
      "relatedProducts": [
        "example"
      ]
    }
  ],
  "warnings": [
    {
      "ruleName": "example",
      "message": "example",
      "shortMessage": "example",
      "category": "example",
      "relatedProducts": [
        "example"
      ]
    }
  ]
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
errors
required
Array<object>
object
fieldName
required
string
message
required
string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "fieldName": "example",
      "message": "example"
    }
  ],
  "code": "example",
  "traceId": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}