Skip to main content

Start configuration session

POST 
/configurator/:version/configurator/new/:featureModelName

Start a new configuration. Note: when using an existing configuration id / code, the configuration will be copied and a new configuration will be started.

Request​

Path Parameters

    featureModelName stringrequired

    Name of the configuration model. The name can be either the feature name, configuration model ID, or a previous configuration session code

    version stringrequired

Body

The input model

    languageIso stringnullable

    The language iso code to start the configuration in

    preview boolean

    Whether the configuration should be started in preview mode

    includeSearchbarResults boolean
    debug boolean
    includeHiddenNodes boolean

    startupRequirements

    object[]

    nullable

  • Array [

    • nodeId uuid

    The id of the node for which the requirement is set

    type int32

    Possible values: [0, 1, 2]

    Selection, Value, TextValue

    value nullable

    The value of the requirement. Can be a number or a string

  • ]

Responses​

Success

Schema

    id uuid
    code stringnullable
    name stringnullable
    arEnabled boolean
    configurationModelId uuid
    foreignConfigurationModelIds uuid[]nullable

    root

    object

    id uuid
    configurationModelId uuid
    parentId uuidnullable
    featureId uuid
    value double
    textValue stringnullable
    imageValue stringnullable
    isSelected boolean
    code stringnullable
    description stringnullable
    extendedDescription stringnullable
    moreInfo stringnullable
    name stringnullable
    articleCode stringnullable
    unitOfMeasurement stringnullable
    imageUrl stringnullable
    type int32

    Possible values: [0, 1, 2, 3, 4, 5, 6]

    Optional, Mandatory, Alternative, Or, Required, Excludes, Implies

    features undefined[]nullable
    featureType int32

    Possible values: [0, 2, 3, 4]

    Feature, ColorPicker, Text, Image

    isBestMatch boolean
    isMandatory boolean
    hideTextValue boolean
    displayType int32

    Possible values: [0, 1, 2, 4, 5, 6, 7, 8, 9]

    Standard, ImageBox, Dropdown, Searchbar, Table, NonDialogSearchbar, Slider, Input, Dialog

    hideInQuotation boolean
    unitPrice stringnullable
    unitPriceExclVat double
    unitPriceInclVat stringnullable
    totalPrice stringnullable
    totalPriceExclVat double
    totalPriceInclVat stringnullable

    price

    object

    unitPriceExcVat double
    unitPriceIncVat double
    totalPriceIncVat double
    totalPriceExcVat double
    minValue double
    maxValue double
    stepValue double
    threeDModelItems string[]nullable
    hiddenThreeDModelItems string[]nullable
    isDisabled boolean
    disabledReason stringnullable
    searchbarColumns string[]nullable
    configurationId uuid
    reference stringnullable
    allowCardinality boolean
    cardinalityMin int32nullable
    cardinalityMax int32nullable
    dynamicGroupId uuidnullable

    customProperties

    object

    nullable

    property name*

    undefined[]

    nullable

  • Array [

  • ]

    • linkedMachinesNode

    object

    id uuid
    configurationModelId uuid
    parentId uuidnullable
    featureId uuid
    value double
    textValue stringnullable
    imageValue stringnullable
    isSelected boolean
    code stringnullable
    description stringnullable
    extendedDescription stringnullable
    moreInfo stringnullable
    name stringnullable
    articleCode stringnullable
    unitOfMeasurement stringnullable
    imageUrl stringnullable
    type int32

    Possible values: [0, 1, 2, 3, 4, 5, 6]

    Optional, Mandatory, Alternative, Or, Required, Excludes, Implies

    features undefined[]nullable
    featureType int32

    Possible values: [0, 2, 3, 4]

    Feature, ColorPicker, Text, Image

    isBestMatch boolean
    isMandatory boolean
    hideTextValue boolean
    displayType int32

    Possible values: [0, 1, 2, 4, 5, 6, 7, 8, 9]

    Standard, ImageBox, Dropdown, Searchbar, Table, NonDialogSearchbar, Slider, Input, Dialog

    hideInQuotation boolean
    unitPrice stringnullable
    unitPriceExclVat double
    unitPriceInclVat stringnullable
    totalPrice stringnullable
    totalPriceExclVat double
    totalPriceInclVat stringnullable

    price

    object

    unitPriceExcVat double
    unitPriceIncVat double
    totalPriceIncVat double
    totalPriceExcVat double
    minValue double
    maxValue double
    stepValue double
    threeDModelItems string[]nullable
    hiddenThreeDModelItems string[]nullable
    isDisabled boolean
    disabledReason stringnullable
    searchbarColumns string[]nullable
    configurationId uuid
    reference stringnullable
    allowCardinality boolean
    cardinalityMin int32nullable
    cardinalityMax int32nullable
    dynamicGroupId uuidnullable

    customProperties

    object

    nullable

    property name*

    undefined[]

    nullable

  • Array [

  • ]

    • steps

    object[]

    nullable

  • Array [

    • id uuid
    configurationModelId uuid
    title stringnullable
    type int32

    Possible values: [0, 1, 2, 3, 4, 5, 7, 8]

    Welcome, ProductSelection, Hotspots, ListView, Overview, ThreeD, ThirdPartyVisualization, Cards

    features

    object[]

    nullable

  • Array [

    • id uuid
    configurationModelId uuid
    parentId uuidnullable
    featureId uuid
    value double
    textValue stringnullable
    imageValue stringnullable
    isSelected boolean
    code stringnullable
    description stringnullable
    extendedDescription stringnullable
    moreInfo stringnullable
    name stringnullable
    articleCode stringnullable
    unitOfMeasurement stringnullable
    imageUrl stringnullable
    type int32

    Possible values: [0, 1, 2, 3, 4, 5, 6]

    Optional, Mandatory, Alternative, Or, Required, Excludes, Implies

    features undefined[]nullable
    featureType int32

    Possible values: [0, 2, 3, 4]

    Feature, ColorPicker, Text, Image

    isBestMatch boolean
    isMandatory boolean
    hideTextValue boolean
    displayType int32

    Possible values: [0, 1, 2, 4, 5, 6, 7, 8, 9]

    Standard, ImageBox, Dropdown, Searchbar, Table, NonDialogSearchbar, Slider, Input, Dialog

    hideInQuotation boolean
    unitPrice stringnullable
    unitPriceExclVat double
    unitPriceInclVat stringnullable
    totalPrice stringnullable
    totalPriceExclVat double
    totalPriceInclVat stringnullable

    price

    object

    unitPriceExcVat double
    unitPriceIncVat double
    totalPriceIncVat double
    totalPriceExcVat double
    minValue double
    maxValue double
    stepValue double
    threeDModelItems string[]nullable
    hiddenThreeDModelItems string[]nullable
    isDisabled boolean
    disabledReason stringnullable
    searchbarColumns string[]nullable
    configurationId uuid
    reference stringnullable
    allowCardinality boolean
    cardinalityMin int32nullable
    cardinalityMax int32nullable
    dynamicGroupId uuidnullable

    customProperties

    object

    nullable

    property name*

    undefined[]

    nullable

  • Array [

  • ]

  • ]

    • cameraPositions

    object[]

    nullable

  • Array [

    • id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    cameraPosX double
    cameraPosY double
    cameraPosZ double
    cameraTargetX double
    cameraTargetY double
    cameraTargetZ double
    cameraFov double
    cameraPivotX double
    cameraPivotY double
    cameraPivotZ double
    cameraWorldUpX double
    cameraWorldUpY double
    cameraWorldUpZ double
    rotationX doublenullable
    rotationY doublenullable
    rotationZ doublenullable
    state stringnullable
    featureModelNodeId uuidnullable
    stepId uuidnullable

  • ]

    • mainCameraPosition

    object

    id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    cameraPosX double
    cameraPosY double
    cameraPosZ double
    cameraTargetX double
    cameraTargetY double
    cameraTargetZ double
    cameraFov double
    cameraPivotX double
    cameraPivotY double
    cameraPivotZ double
    cameraWorldUpX double
    cameraWorldUpY double
    cameraWorldUpZ double
    rotationX doublenullable
    rotationY doublenullable
    rotationZ doublenullable
    state stringnullable
    featureModelNodeId uuidnullable
    stepId uuidnullable
    iconUrl stringnullable

    hotspots

    object[]

    nullable

  • Array [

    • id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    x double
    y double
    z double
    stepId uuid
    featureModelNodeId uuid
    parentFeatureModelNodeId uuid
    showMoreInfo boolean
    title stringnullable
    color stringnullable
    guidedSellingNodeIds string[]nullable

  • ]

    • configuratorImages

    object[]

    nullable

  • Array [

    • id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    stepId uuid
    x int32
    y int32
    z int32
    type int32

    Possible values: [0, 1]

    Standard, Magnifier

    url stringnullable
    featureModelNodeIds string[]nullable
    isHidden boolean

  • ]

    • backgroundUrl stringnullable
    thirdPartyUrl stringnullable
    sendDataOnConfigurationUpdate boolean

  • ]

    • preconfigurationFeatures

    object[]

    nullable

  • Array [

    • id uuid
    configurationModelId uuid
    parentId uuidnullable
    featureId uuid
    value double
    textValue stringnullable
    imageValue stringnullable
    isSelected boolean
    code stringnullable
    description stringnullable
    extendedDescription stringnullable
    moreInfo stringnullable
    name stringnullable
    articleCode stringnullable
    unitOfMeasurement stringnullable
    imageUrl stringnullable
    type int32

    Possible values: [0, 1, 2, 3, 4, 5, 6]

    Optional, Mandatory, Alternative, Or, Required, Excludes, Implies

    features undefined[]nullable
    featureType int32

    Possible values: [0, 2, 3, 4]

    Feature, ColorPicker, Text, Image

    isBestMatch boolean
    isMandatory boolean
    hideTextValue boolean
    displayType int32

    Possible values: [0, 1, 2, 4, 5, 6, 7, 8, 9]

    Standard, ImageBox, Dropdown, Searchbar, Table, NonDialogSearchbar, Slider, Input, Dialog

    hideInQuotation boolean
    unitPrice stringnullable
    unitPriceExclVat double
    unitPriceInclVat stringnullable
    totalPrice stringnullable
    totalPriceExclVat double
    totalPriceInclVat stringnullable

    price

    object

    unitPriceExcVat double
    unitPriceIncVat double
    totalPriceIncVat double
    totalPriceExcVat double
    minValue double
    maxValue double
    stepValue double
    threeDModelItems string[]nullable
    hiddenThreeDModelItems string[]nullable
    isDisabled boolean
    disabledReason stringnullable
    searchbarColumns string[]nullable
    configurationId uuid
    reference stringnullable
    allowCardinality boolean
    cardinalityMin int32nullable
    cardinalityMax int32nullable
    dynamicGroupId uuidnullable

    customProperties

    object

    nullable

    property name*

    undefined[]

    nullable

  • Array [

  • ]

  • ]

    • unansweredMandatories

    object[]

    nullable

  • Array [

    • id uuid
    configurationModelId uuid
    parentId uuidnullable
    featureId uuid
    value double
    textValue stringnullable
    imageValue stringnullable
    isSelected boolean
    code stringnullable
    description stringnullable
    extendedDescription stringnullable
    moreInfo stringnullable
    name stringnullable
    articleCode stringnullable
    unitOfMeasurement stringnullable
    imageUrl stringnullable
    type int32

    Possible values: [0, 1, 2, 3, 4, 5, 6]

    Optional, Mandatory, Alternative, Or, Required, Excludes, Implies

    features undefined[]nullable
    featureType int32

    Possible values: [0, 2, 3, 4]

    Feature, ColorPicker, Text, Image

    isBestMatch boolean
    isMandatory boolean
    hideTextValue boolean
    displayType int32

    Possible values: [0, 1, 2, 4, 5, 6, 7, 8, 9]

    Standard, ImageBox, Dropdown, Searchbar, Table, NonDialogSearchbar, Slider, Input, Dialog

    hideInQuotation boolean
    unitPrice stringnullable
    unitPriceExclVat double
    unitPriceInclVat stringnullable
    totalPrice stringnullable
    totalPriceExclVat double
    totalPriceInclVat stringnullable

    price

    object

    unitPriceExcVat double
    unitPriceIncVat double
    totalPriceIncVat double
    totalPriceExcVat double
    minValue double
    maxValue double
    stepValue double
    threeDModelItems string[]nullable
    hiddenThreeDModelItems string[]nullable
    isDisabled boolean
    disabledReason stringnullable
    searchbarColumns string[]nullable
    configurationId uuid
    reference stringnullable
    allowCardinality boolean
    cardinalityMin int32nullable
    cardinalityMax int32nullable
    dynamicGroupId uuidnullable

    customProperties

    object

    nullable

    property name*

    undefined[]

    nullable

  • Array [

  • ]

  • ]

    • linkedConfigurationModels

    object[]

    nullable

  • Array [

    • parentNodeId uuid
    configurationModelId uuid
    configurationModelName stringnullable
    allowCardinality boolean
    allowMultiplier boolean

  • ]

    • linkedConfigurations

    object[]

    nullable

  • Array [

    • id uuid
    configurationId uuid
    linkedConfigurationId uuid
    parentNodeId uuid
    rootFeatureId uuid

    rootFeature

    object

    id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    name stringnullable
    articleCode stringnullable
    type int32

    Possible values: [0, 2, 3, 4]

    Feature, ColorPicker, Text, Image

    salesPrice double
    disallowDiscount boolean
    salesPriceLabel stringnullable
    formattedStartingPriceLabel stringnullable
    minValue double
    maxValue double
    stepValue double
    packingUnit double

    category

    object

    id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    name stringnullable

    texts

    object[]

    nullable

  • Array [

    • id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    value stringnullable
    languageIso stringnullable

    Possible values: <= 3 characters

    categoryId uuid

  • ]

    • parentId uuidnullable
    order int32
    linkedFeatures int32nullable
    categoryId uuidnullable
    _subcategoryIds stringnullable
    subcategoryIds uuid[]nullable
    threeDModelItems string[]nullable
    hiddenThreeDModelItems string[]nullable
    tags string[]nullable
    searchableTags stringnullable
    marginPct double

    texts

    object[]

    nullable

  • Array [

    • id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    value stringnullable
    languageIso stringnullable

    Possible values: <= 3 characters

    type int32

    Possible values: [0, 1, 2, 3, 4, 5]

    Description, ExtendedDescription, MoreInfo, Title, PromptMessage, QuotationText

    featureId uuid

  • ]

    • cardImageUrl stringnullable
    vatId uuidnullable
    unitOfMeasurementId uuidnullable

    unitOfMeasurement

    object

    id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    code stringnullable
    description stringnullable

    texts

    object[]

    nullable

  • Array [

    • id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    unitOfMeasurement
    languageIso stringnullable
    description stringnullable
    code stringnullable

  • ]

    • order int32
    path stringnullable
    name stringnullable
    unitPrice stringnullable
    unitPriceInclVat stringnullable
    totalPrice stringnullable
    totalPriceInclVat stringnullable
    multiplier int32
    combinedInView boolean

  • ]

    • values

    object

    nullable

    property name* nullable

    [object Object]

    textValues

    object

    nullable

    property name* string

    imageValues

    object

    nullable

    property name* string

    requirements

    object[]

    nullable

  • Array [

    • nodeId uuid
    value double

  • ]

    • language stringnullable
    currency stringnullable

    languages

    object

    nullable

    property name* string

    additionalPricesIncVat

    object

    nullable

    property name* string

    additionalPricesExVat

    object

    nullable

    property name* string

    totalPricesIncVat

    object

    nullable

    property name* string

    totalPricesExVat

    object

    nullable

    property name* string

    basePricesExVat

    object

    nullable

    property name* string

    basePricesIncVat

    object

    nullable

    property name* string
    basePriceExclVat stringnullable
    basePriceInclVat stringnullable
    basePriceExclVatNumber double
    basePriceInclVatNumber double
    basePrice double
    additionalPriceExclVat stringnullable
    additionalPriceInclVat stringnullable
    additionalPriceExclVatNumber double
    additionalPriceInclVatNumber double
    additionalPrice double
    totalPriceExclVat stringnullable
    totalPriceInclVat stringnullable
    totalPriceExclVatNumber double
    totalPriceInclVatNumber double
    totalPrice doublenullable
    autodeskUrn stringnullable
    autodeskIntegrationApplicationId uuidnullable

    foreignAutodeskUrns

    object

    nullable

    property name* string

    foreignAttachmentNodes

    object

    nullable

    property name*

    object[]

    nullable

  • Array [

    • id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    featureModelId uuid
    featureModelNode uuidnullable
    name stringnullable
    x double
    y double
    z double
    featureModelNodeX uuidnullable
    featureModelNodeY uuidnullable
    featureModelNodeZ uuidnullable
    rotation double
    featureModelNodeRotationY uuidnullable
    attachTo stringnullable

  • ]

    • attachmentNodes

    object[]

    nullable

  • Array [

    • id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    featureModelId uuid
    featureModelNode uuidnullable
    name stringnullable
    x double
    y double
    z double
    featureModelNodeX uuidnullable
    featureModelNodeY uuidnullable
    featureModelNodeZ uuidnullable
    rotation double
    featureModelNodeRotationY uuidnullable
    attachTo stringnullable

  • ]

    • threeDItemsToHide string[]nullable

    threeDItemMappings

    object

    nullable

    property name*

    Mapped3dItems

    nullable

    visibleItems string[]nullable
    hiddenItems string[]nullable

    itemColors

    object

    nullable

    property name*

    float[]

    nullable

  • Array [

    • number

  • ]

    • itemMaterials

    object

    nullable

    property name*

    Material

    nullable

    id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    name stringnullable
    type int32

    Possible values: [0, 1, 2]

    Basic, Lambert, Phong

    color stringnullable
    ambient stringnullable
    emissive stringnullable
    specular stringnullable
    wireframe boolean
    map stringnullable
    envMap stringnullable
    alphaTest double
    side int32

    Possible values: [0, 1, 2]

    Front, Back, Double

    transparant boolean
    opacity double
    fog boolean
    lightMap stringnullable
    specularMap stringnullable
    normalMap stringnullable
    bumpMap stringnullable
    bumpScale double
    shininess double
    metal boolean
    reflectivity double
    refractionRatio double
    combine int32

    Possible values: [0, 1, 2]

    Multiply, Mix, Add

    envMapMapping int32
    textureWrapX int32

    Possible values: [0, 1, 2]

    Clamp, Repeat, Mirrored

    textureWrapY int32

    Possible values: [0, 1, 2]

    Clamp, Repeat, Mirrored

    textureRepeatX double
    textureRepeatY double
    textureFlipY boolean
    previewImageUrl stringnullable

    conflicts

    object[]

    nullable

  • Array [

    • featurePath string[]nullable

    feature

    object

    id uuid
    configurationModelId uuid
    parentId uuidnullable
    featureId uuid
    value double
    textValue stringnullable
    imageValue stringnullable
    isSelected boolean
    code stringnullable
    description stringnullable
    extendedDescription stringnullable
    moreInfo stringnullable
    name stringnullable
    articleCode stringnullable
    unitOfMeasurement stringnullable
    imageUrl stringnullable
    type int32

    Possible values: [0, 1, 2, 3, 4, 5, 6]

    Optional, Mandatory, Alternative, Or, Required, Excludes, Implies

    features undefined[]nullable
    featureType int32

    Possible values: [0, 2, 3, 4]

    Feature, ColorPicker, Text, Image

    isBestMatch boolean
    isMandatory boolean
    hideTextValue boolean
    displayType int32

    Possible values: [0, 1, 2, 4, 5, 6, 7, 8, 9]

    Standard, ImageBox, Dropdown, Searchbar, Table, NonDialogSearchbar, Slider, Input, Dialog

    hideInQuotation boolean
    unitPrice stringnullable
    unitPriceExclVat double
    unitPriceInclVat stringnullable
    totalPrice stringnullable
    totalPriceExclVat double
    totalPriceInclVat stringnullable

    price

    object

    unitPriceExcVat double
    unitPriceIncVat double
    totalPriceIncVat double
    totalPriceExcVat double
    minValue double
    maxValue double
    stepValue double
    threeDModelItems string[]nullable
    hiddenThreeDModelItems string[]nullable
    isDisabled boolean
    disabledReason stringnullable
    searchbarColumns string[]nullable
    configurationId uuid
    reference stringnullable
    allowCardinality boolean
    cardinalityMin int32nullable
    cardinalityMax int32nullable
    dynamicGroupId uuidnullable

    customProperties

    object

    nullable

    property name*

    undefined[]

    nullable

  • Array [

  • ]

    • alternativeOptions

    object[]

    nullable

  • Array [

    • id uuid
    configurationModelId uuid
    parentId uuidnullable
    featureId uuid
    value double
    textValue stringnullable
    imageValue stringnullable
    isSelected boolean
    code stringnullable
    description stringnullable
    extendedDescription stringnullable
    moreInfo stringnullable
    name stringnullable
    articleCode stringnullable
    unitOfMeasurement stringnullable
    imageUrl stringnullable
    type int32

    Possible values: [0, 1, 2, 3, 4, 5, 6]

    Optional, Mandatory, Alternative, Or, Required, Excludes, Implies

    features undefined[]nullable
    featureType int32

    Possible values: [0, 2, 3, 4]

    Feature, ColorPicker, Text, Image

    isBestMatch boolean
    isMandatory boolean
    hideTextValue boolean
    displayType int32

    Possible values: [0, 1, 2, 4, 5, 6, 7, 8, 9]

    Standard, ImageBox, Dropdown, Searchbar, Table, NonDialogSearchbar, Slider, Input, Dialog

    hideInQuotation boolean
    unitPrice stringnullable
    unitPriceExclVat double
    unitPriceInclVat stringnullable
    totalPrice stringnullable
    totalPriceExclVat double
    totalPriceInclVat stringnullable

    price

    object

    unitPriceExcVat double
    unitPriceIncVat double
    totalPriceIncVat double
    totalPriceExcVat double
    minValue double
    maxValue double
    stepValue double
    threeDModelItems string[]nullable
    hiddenThreeDModelItems string[]nullable
    isDisabled boolean
    disabledReason stringnullable
    searchbarColumns string[]nullable
    configurationId uuid
    reference stringnullable
    allowCardinality boolean
    cardinalityMin int32nullable
    cardinalityMax int32nullable
    dynamicGroupId uuidnullable

    customProperties

    object

    nullable

    property name*

    undefined[]

    nullable

  • Array [

  • ]

  • ]

    • type int32

    Possible values: [0, 1, 2, 3]

    Add, Remove, Alternative, Value

    requestedValue double
    actualValue double

  • ]

    • leasePricesLabels

    object

    nullable

    property name* string
Loading...