Create Cluster

POST 
/clusters/

Use this endpoint to create a single cluster. If a cluster is successfully created, the response will include the cluster id.

Fields

Name	Required
names	no
descriptions	no
shortDescriptions	no
language	no
parent	no
sourceId	no
source	only when sourceId is provided
clusterConfigId	yes
code	no

Request

application/json

Body

clusterConfigId number

descriptions

object[]

Array [

language string

value string

]

language string

names

object[]

Array [

language string

value string

]

parent

object

id number
sku string
source string
sourceId string

Responses

201

Create Cluster - 201

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

Schema

data

object

clusterConfigId number

code string

descriptions

object[]

Array [

language string

value string

]

id number

language string

names

object[]

Array [

language string

value string

]

parent

object

id number

source string

sourceId string
messages string[]
total number

Example (from schema)

{
  "data": {
    "clusterConfigId": 11,
    "code": "15120300",
    "descriptions": [
      {
        "language": "NL",
        "value": "Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."
      }
    ],
    "id": 210,
    "language": "NL",
    "names": [
      {
        "language": "NL",
        "value": "Balpen Slider XB extra"
      }
    ],
    "parent": {
      "id": 23409
    },
    "source": "REST-API",
    "sourceId": "15120300"
  },
  "messages": [
    "Cluster created"
  ],
  "total": 1
}

Create Cluster - 201

{
  "data": {
    "clusterConfigId": 11,
    "code": "15120300",
    "descriptions": [
      {
        "language": "NL",
        "value": "Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."
      }
    ],
    "id": 210,
    "language": "NL",
    "names": [
      {
        "language": "NL",
        "value": "Balpen Slider XB extra"
      }
    ],
    "parent": {
      "id": 23409
    },
    "source": "REST-API",
    "sourceId": "15120300"
  },
  "messages": [
    "Cluster created"
  ],
  "total": 1
}

400

Create Cluster - 400

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#: extraneous key [sku] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Create Cluster - 400

{
  "error": {
    "code": 10007,
    "messages": [
      "#: extraneous key [sku] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Loading...