Skip to main content
API docs by Redocly

Elfsquad Configurator API (v1)

Download OpenAPI specification:Download

ConfigurationModels

Configurations endpoint

Get configuration models

Retrieves a list of all available configuration models

path Parameters
version
required
string
query Parameters
lang
string

(Optional) Language ISO

Responses

Response samples

Content type
No sample

Configurator

Configurations endpoint

Open existing configuration

path Parameters
configurationId
required
string

Identifier or code of the configuration session

version
required
string
query Parameters
ignoreConflicts
boolean
Default: false

(Optional) You can choose to ignore conflicts that may have occurred because of changes in the underlying configuration model

includeSearchbarResults
boolean
Default: true
lang
string

Responses

Response samples

Content type
No sample

/configurator/{version}/configurator/open/multiple

path Parameters
version
required
string
query Parameters
configurationIds
Array of strings
includeSearchbarResults
boolean
Default: true
ignoreConflicts
boolean
Default: false
lang
string

Responses

Response samples

Content type
No sample

Update requirement

path Parameters
configurationId
required
string <uuid>

Identifier of the configuration

version
required
string
query Parameters
ignoreConflicts
boolean

(Optional) Ignore conflicts

includeSearchbarResults
boolean
Default: true
debug
boolean
Default: false
Request Body schema:

Requirement

featureModelNodeId
string <uuid>
value
number <double>
isSelection
boolean

Responses

Request samples

Content type
{
  • "featureModelNodeId": "fd1b88e2-396c-47dc-aac2-ee7e5b668f17",
  • "value": 0,
  • "isSelection": true
}

Response samples

Content type
No sample

Update text value

Updates the text value of a feature model node in the configuration

path Parameters
id
required
string <uuid>

The configuration identifier

version
required
string
query Parameters
includeSearchbarResults
boolean
Default: true
Request Body schema:

The updated requirement e.g. { featureModelNodeId: string, textValue: string }

featureModelNodeId
string <uuid>
textValue
string or null

Responses

Request samples

Content type
{
  • "featureModelNodeId": "fd1b88e2-396c-47dc-aac2-ee7e5b668f17",
  • "textValue": "string"
}

Response samples

Content type
No sample

Update multiple text values

Updates the text values of feature model nodes in the configuration

path Parameters
id
required
string <uuid>

The configuration identifier

version
required
string
query Parameters
includeSearchbarResults
boolean
Default: true
Request Body schema:

The updated requirements e.g. [ { featureModelNodeId: string, textValue: string } ]

Array
featureModelNodeId
string <uuid>
textValue
string or null

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
No sample

/configurator/{version}/configurator/updatelinkedconfigurationcardinality

path Parameters
version
required
string
Request Body schema:
configurationId
string or null
cardinality
integer <int32>
parentNodeId
string or null

Responses

Request samples

Content type
{
  • "configurationId": "string",
  • "cardinality": 0,
  • "parentNodeId": "string"
}

Response samples

Content type
No sample

/configurator/{version}/configurator/{configurationId}/cardinality

path Parameters
configurationId
required
string <uuid>
version
required
string
Request Body schema:
nodeId
string <uuid>
cardinality
integer <int32>
index
integer <int32>

Responses

Request samples

Content type
{
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177",
  • "cardinality": 0,
  • "index": 0
}

Response samples

Content type
No sample

Change language

path Parameters
configurationId
required
string <uuid>

Identifier of the configuration

version
required
string
query Parameters
includeSearchbarResults
boolean
Default: true
Request Body schema:

Language ISO

string

Responses

Request samples

Content type
"string"

Response samples

Content type
No sample

/configurator/{version}/configurator/changelanguage

path Parameters
version
required
string
query Parameters
includeSearchbarResults
boolean
Default: true
Request Body schema:
configurationId
string or null
languageIso
string or null

Responses

Request samples

Content type
{
  • "configurationId": "string",
  • "languageIso": "string"
}

Response samples

Content type
No sample

Get step image

path Parameters
id
required
string <uuid>

Identifier of the configuration

version
required
string
query Parameters
stepId
string <uuid>

Identifier of the step

size
integer <int32>

(Optional) size of the image in pixels

background
boolean
Default: true

(Optional) Display background in the image

c
string

Responses

Response samples

Content type
No sample

Generate PDF

path Parameters
configurationId
required
string <uuid>

Identifier of the configuration

version
required
string
query Parameters
templateId
string <uuid>
currencyIso
string
languageIso
string

Responses

Duplicate configuration

path Parameters
configurationId
required
string <uuid>

Identifier of the configuration

version
required
string
query Parameters
value
integer <int32>
Default: 1

(Optional) Amount of duplicates

Responses

Response samples

Content type
No sample

Retrieve 2D image layout

path Parameters
id
required
string <uuid>

Configuration Id

version
required
string
query Parameters
stepId
string <uuid>

Identifier of the step

Responses

Response samples

Content type
No sample

Retrieve 3D layout

path Parameters
id
required
string <uuid>

Configuration Id

version
required
string

Responses

Response samples

Content type
No sample

Add configuration to quotation

path Parameters
version
required
string
Request Body schema:
quotationId
string <uuid>
configurationIds
Array of strings or null <uuid>
object or null

Responses

Request samples

Content type
{
  • "quotationId": "98c8afab-b1d9-462f-9483-5a2dbf34985f",
  • "configurationIds": [
    ],
  • "quantities": {
    }
}

/configurator/{version}/configurator/{configurationId}/linkedconfigurations/overview

path Parameters
configurationId
required
string <uuid>
version
required
string

Responses

/configurator/{version}/configurator/requestquote

path Parameters
version
required
string
Request Body schema:
object (QuotationRequestViewModel)
configurationIds
Array of strings or null <uuid>
object or null

Responses

Request samples

Content type
{
  • "quotationRequest": {
    },
  • "configurationIds": [
    ],
  • "quantities": {
    }
}

NewConfiguration

New configuration endpoint

Starts a new configuration session

path Parameters
featureModelName
required
string

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

version
required
string
query Parameters
lang
string

(Optional) Language ISO

preview
boolean
Default: false
includeSearchbarResults
boolean
Default: true
debug
boolean
Default: false

Responses

Response samples

Content type
No sample

Settings

Configuration settings endpoint

Retrieve settings

Settings that can be applied to the configurator such as theme preferences

path Parameters
version
required
string
query Parameters
lang
string

(Optional) Language ISO

Responses

Response samples

Content type
No sample

Internal

/configurator/1/_internal/_resetExpressionCache

Request Body schema:
expressionId
string <uuid>

Responses

Request samples

Content type
{
  • "expressionId": "98a623dd-0690-4acb-bbad-b1eda4955cc3"
}