# VariantGroups

#Available from v.3.11.0 Variant groups are used to contain data for a group of variants on a product. Variant group entities contain attribute data, classifications in categories and variants. The data model for variant groups are described by product structures.

GET /variantgroups Get basic models for variant groups

No more than 5000 variant groups can be requested at a time. If no limit is provided, the default limit of 1000 will be used. By default, archived variant groups are not returned

Request parameters

Property name Parameter type Data type Description
includeArchived query boolean

Include archived variant groups

limit query integer

Number of variant groups to return

afterId query integer

Only return variant groups with id larger than this value

Response status OK (200)

object : VariantGroupsResultSet
VariantGroupsResultSet
Property name Data type Description
VariantGroups array : VariantGroupModel

List of variant groups in result set

Total integer

The total number of items

Remaining integer

The remaining items that lie after the last id of the item in this result set

LastId integer

The id of the last item in this result set

VariantGroupModel
Property name Data type Description
Id integer

Unique id of the variant group

Name object

Display name of variant group (Dictionary of ISO culture code and name)

Created string

Timestamp of the variant group creation

CreatedBy string

Username of the user who created the variant group

LastModified string

Timestamp of the last variant group update

LastModifiedBy string

Username of the user who made the last change to the variant group

IsArchived boolean

Indicates whether the variant group is archived

ArchiveReason string

The uid of the archive reason selected when the variant group was archived

ProductId integer

The id of the product to which the variant group is associated

SortOrder integer

The sortorder of the variant group in relation to its associated product

WorkflowStateUid string

The uid of the workflow state of the variant group


POST /variantgroups Create new variant groups

A maximum of 5000 variant groups can be created in one request

Request parameters

Property name Parameter type Data type Description
variantGroups body array : CreateVariantGroupModel

VariantGroups

CreateVariantGroupModel
Property name Data type Description
ProductId integer

Product to associate variant group to

Classifications array : VariantGroupClassificationModel

Classifications for variant group

WorkflowStateUid string

Workflow state to set on the variant group

Values object

Dictionary of attribute alias and the corresponding attribute value as an object representation

The table below shows how different attributes translates to this value model.

Attribute type data type
Text attribute string
Number attribute decimal
Boolean attribute bool
Fixedlist attribute value/value[] (depending on whether attribute allows selecting multiple global list values). The datatype of this value model depends on the underlying attribute for the global list of the refernced global list value(s)
Media attribute string/string[] (depending on whether attribute allows selecting multiple medias)
Datetime attribute DateTimeOffset
Category attribute int/int[] (depending on whether attribute allows selecting multiple categories)
Product attribute int/int[] (depending on whether attribute allows selecting multiple products)
Variant attribute int/int[] (depending on whether attribute allows selecting multiple variants)
Collection attribute uuid/uuid[] (depending on whether attribute allows selecting multiple collections)
Attribute attribute string/string[] (depending on whether attribute allows selecting multiple attributes)
Complex attribute object (Each property of the object corresponds to each sub attribute of the complex attribute. The value of each property then corresponds to the data type of that sub attribute)
List attribute value[] (Each value in the array represents each row in the list. The model of each row corresponds to the datatype of the row template set up on the list attribute)
VariantGroupClassificationModel
Property name Data type Description
CategoryId integer

Id of category the variant group is placed in

OwnerReference string

A reference to where this classification comes from. If the classification is made in the PIM interface, this will be null. When creating or updating classifications of variant groups through API this can be set to any value. Thus, classifications made from the API can be distinguished from those made directly in the UI

SortOrder integer

Sort order of the variant group in this category

Response status OK (200)

array : integer

DELETE /variantgroups Delete multiple variant groups

Request parameters

Property name Parameter type Data type Description
variantGroupIds body array : integer

Ids of variant groups to delete

Response status OK (200)

No body message is returned

PATCH /variantgroups Update multiple variant groups

Request parameters

Property name Parameter type Data type Description
variantGroups body array : BatchUpdateVariantGroupModel

Update model

BatchUpdateVariantGroupModel
Property name Data type Description
VariantGroupId integer

Id of variant group to update

UpdateModel object : UpdateVariantGroupModel

Model containing updates to make on variant group (properties with null values are ignored and does not cause an update)

UpdateVariantGroupModel
Property name Data type Description
IsArchived boolean

Indicate whether the variant group shall be archived or un-archived

ArchiveReason string

Reference to the archive reason when archiving variant group (if IsArchived is true)

Classifications array : VariantGroupClassificationModel

Categories to add the variant group to

WorkflowStateUid string

Workflow state to set on the variant group

Values object

Dictionary of attribute alias and the corresponding attribute value as an object representation

The table below shows how different attributes translates to this value model.

Attribute type data type
Text attribute string
Number attribute decimal
Boolean attribute bool
Fixedlist attribute value/value[] (depending on whether attribute allows selecting multiple global list values). The datatype of this value model depends on the underlying attribute for the global list of the refernced global list value(s)
Media attribute string/string[] (depending on whether attribute allows selecting multiple medias)
Datetime attribute DateTimeOffset
Category attribute int/int[] (depending on whether attribute allows selecting multiple categories)
Product attribute int/int[] (depending on whether attribute allows selecting multiple products)
Variant attribute int/int[] (depending on whether attribute allows selecting multiple variants)
Collection attribute uuid/uuid[] (depending on whether attribute allows selecting multiple collections)
Attribute attribute string/string[] (depending on whether attribute allows selecting multiple attributes)
Complex attribute object (Each property of the object corresponds to each sub attribute of the complex attribute. The value of each property then corresponds to the data type of that sub attribute)
List attribute value[] (Each value in the array represents each row in the list. The model of each row corresponds to the datatype of the row template set up on the list attribute)
VariantGroupClassificationModel
Property name Data type Description
CategoryId integer

Id of category the variant group is placed in

OwnerReference string

A reference to where this classification comes from. If the classification is made in the PIM interface, this will be null. When creating or updating classifications of variant groups through API this can be set to any value. Thus, classifications made from the API can be distinguished from those made directly in the UI

SortOrder integer

Sort order of the variant group in this category

Response status OK (200)

No body message is returned

GET /variantgroups/{id} Get basic model for a variant group

Request parameters

Property name Parameter type Data type Description
id path integer

Id of variant group to return

Response status OK (200)

object : VariantGroupModel
VariantGroupModel
Property name Data type Description
Id integer

Unique id of the variant group

Name object

Display name of variant group (Dictionary of ISO culture code and name)

Created string

Timestamp of the variant group creation

CreatedBy string

Username of the user who created the variant group

LastModified string

Timestamp of the last variant group update

LastModifiedBy string

Username of the user who made the last change to the variant group

IsArchived boolean

Indicates whether the variant group is archived

ArchiveReason string

The uid of the archive reason selected when the variant group was archived

ProductId integer

The id of the product to which the variant group is associated

SortOrder integer

The sortorder of the variant group in relation to its associated product

WorkflowStateUid string

The uid of the workflow state of the variant group


DELETE /variantgroups/{id} Delete a variant group

Request parameters

Property name Parameter type Data type Description
id path integer

Id of variant group to delete

Response status OK (200)

No body message is returned

PATCH /variantgroups/{id} Update a variant group

Request parameters

Property name Parameter type Data type Description
id path integer

Id of variant group

model body object : UpdateVariantGroupModel

Update model

UpdateVariantGroupModel
Property name Data type Description
IsArchived boolean

Indicate whether the variant group shall be archived or un-archived

ArchiveReason string

Reference to the archive reason when archiving variant group (if IsArchived is true)

Classifications array : VariantGroupClassificationModel

Categories to add the variant group to

WorkflowStateUid string

Workflow state to set on the variant group

Values object

Dictionary of attribute alias and the corresponding attribute value as an object representation

The table below shows how different attributes translates to this value model.

Attribute type data type
Text attribute string
Number attribute decimal
Boolean attribute bool
Fixedlist attribute value/value[] (depending on whether attribute allows selecting multiple global list values). The datatype of this value model depends on the underlying attribute for the global list of the refernced global list value(s)
Media attribute string/string[] (depending on whether attribute allows selecting multiple medias)
Datetime attribute DateTimeOffset
Category attribute int/int[] (depending on whether attribute allows selecting multiple categories)
Product attribute int/int[] (depending on whether attribute allows selecting multiple products)
Variant attribute int/int[] (depending on whether attribute allows selecting multiple variants)
Collection attribute uuid/uuid[] (depending on whether attribute allows selecting multiple collections)
Attribute attribute string/string[] (depending on whether attribute allows selecting multiple attributes)
Complex attribute object (Each property of the object corresponds to each sub attribute of the complex attribute. The value of each property then corresponds to the data type of that sub attribute)
List attribute value[] (Each value in the array represents each row in the list. The model of each row corresponds to the datatype of the row template set up on the list attribute)
VariantGroupClassificationModel
Property name Data type Description
CategoryId integer

Id of category the variant group is placed in

OwnerReference string

A reference to where this classification comes from. If the classification is made in the PIM interface, this will be null. When creating or updating classifications of variant groups through API this can be set to any value. Thus, classifications made from the API can be distinguished from those made directly in the UI

SortOrder integer

Sort order of the variant group in this category

Response status OK (200)

No body message is returned

GET /variantgroups/{id}/attributevalues Get attribute values for a variant group

Request parameters

Property name Parameter type Data type Description
id path integer

Id of variant group

globalListValueReferencesOnly query boolean

Indicate if only uids of referenced to global list values shall be returned instead of the materialized values

Response status OK (200)

object : VariantGroupAttributeValuesModel
VariantGroupAttributeValuesModel
Property name Data type Description
VariantGroupId integer

Id of variant group

Values object

Dictionary of attribute alias and the corresponding attribute value as an object representation

The table below shows how different attributes translates to this value model.

Attribute type data type
Text attribute string
Number attribute decimal
Boolean attribute bool
Fixedlist attribute value/value[] (depending on whether attribute allows selecting multiple global list values). The datatype of this value model depends on the underlying attribute for the global list of the refernced global list value(s)
Media attribute string/string[] (depending on whether attribute allows selecting multiple medias)
Datetime attribute DateTimeOffset
Category attribute int/int[] (depending on whether attribute allows selecting multiple categories)
Product attribute int/int[] (depending on whether attribute allows selecting multiple products)
Variant attribute int/int[] (depending on whether attribute allows selecting multiple variants)
Collection attribute uuid/uuid[] (depending on whether attribute allows selecting multiple collections)
Attribute attribute string/string[] (depending on whether attribute allows selecting multiple attributes)
Complex attribute object (Each property of the object corresponds to each sub attribute of the complex attribute. The value of each property then corresponds to the data type of that sub attribute)
List attribute value[] (Each value in the array represents each row in the list. The model of each row corresponds to the datatype of the row template set up on the list attribute)

GET /variantgroups/{id}/classifications Get category classifications for a variant group

Request parameters

Property name Parameter type Data type Description
id path integer

Id of variant group

Response status OK (200)

array : VariantGroupClassificationModel
VariantGroupClassificationModel
Property name Data type Description
CategoryId integer

Id of category the variant group is placed in

OwnerReference string

A reference to where this classification comes from. If the classification is made in the PIM interface, this will be null. When creating or updating classifications of variant groups through API this can be set to any value. Thus, classifications made from the API can be distinguished from those made directly in the UI

SortOrder integer

Sort order of the variant group in this category


POST /variantgroups/{id}/classifications Add category classifications to a variant group

Request parameters

Property name Parameter type Data type Description
id path integer

Id of variant group

classifications body array : VariantGroupClassificationModel

Model with variant group id and categories to classify the variant group in

VariantGroupClassificationModel
Property name Data type Description
CategoryId integer

Id of category the variant group is placed in

OwnerReference string

A reference to where this classification comes from. If the classification is made in the PIM interface, this will be null. When creating or updating classifications of variant groups through API this can be set to any value. Thus, classifications made from the API can be distinguished from those made directly in the UI

SortOrder integer

Sort order of the variant group in this category

Response status OK (200)

No body message is returned

DELETE /variantgroups/{id}/classifications Remove category classifications from a variant group

Request parameters

Property name Parameter type Data type Description
id path integer

Id of variant group

categoryIds body array : integer

category ids to remove the variant group from

Response status OK (200)

No body message is returned

GET /variantgroups/{id}/enrichmentinsights Get Enrichment Insights for a variant group

Request parameters

Property name Parameter type Data type Description
id path integer

Id of variant group to get insights for

Response status OK (200)

array : EntityEnrichmentInsight
EntityEnrichmentInsight
Property name Data type Description
EnrichmentInsightSetupUid string

Uid of enrichment insight

EntityId integer

Id of entity

Completeness integer

Completeness in percentage (0 - 100). Is null, if ignored is true

MissingData array : InsightDataReference

List of missing data for this entity to reach 100% completeness for this enrichment insight

Ignored boolean

Indicates whether the completeness is ignored for this entity and this enrichment insight

InsightDataReference
Property name Data type Description
Type string

Type of data reference

DataReference string

The data reference itself


PATCH /variantgroups/{id}/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore} Enable or disable an enrichment insight for a variant group

Request parameters

Property name Parameter type Data type Description
id path integer

Id of variant group

enrichmentInsightSetupUid path string

Uid of enrichment insight to toggle ignore for

ignore path boolean

Indicate whether to ignore the insight for the given enrichment insight and variant groups

Response status OK (200)

No body message is returned

GET /variantgroups/{id}/references Get references to a variant group

Request parameters

Property name Parameter type Data type Description
id path integer

Id of variant group

Response status OK (200)

object : VariantGroupReferences
VariantGroupReferences
Property name Data type Description
VariantGroupId integer

Id of the referenced variant group

ReferencingCategories array : EntityReferenceDetail

List of categories referencing this variant group

ReferencingProducts array : EntityReferenceDetail

List of products referencing this variant group

ReferencingVariantGroups array : EntityReferenceDetail

List of variant groups referencing this variant group

ReferencingVariants array : EntityReferenceDetail

List of variants referencing this variant group

ReferencingGlobalListValues array

List of global list values referencing this variant group

EntityReferenceDetail
Property name Data type Description
EntityId integer

The id of the referencing entity

AttributeUid string

The attribute on the referencing entity that holds the reference


GET /variantgroups/{id}/variants Get ids of variants of a variant group

Request parameters

Property name Parameter type Data type Description
id path integer

Id of variant group

includeArchived query boolean

Return ids of archived variants as well

Response status OK (200)

array : integer

POST /variantgroups/batch Get basic model for a range of variant groups

Request parameters

Property name Parameter type Data type Description
ids body array : integer

Response status OK (200)

array : VariantGroupModel
VariantGroupModel
Property name Data type Description
Id integer

Unique id of the variant group

Name object

Display name of variant group (Dictionary of ISO culture code and name)

Created string

Timestamp of the variant group creation

CreatedBy string

Username of the user who created the variant group

LastModified string

Timestamp of the last variant group update

LastModifiedBy string

Username of the user who made the last change to the variant group

IsArchived boolean

Indicates whether the variant group is archived

ArchiveReason string

The uid of the archive reason selected when the variant group was archived

ProductId integer

The id of the product to which the variant group is associated

SortOrder integer

The sortorder of the variant group in relation to its associated product

WorkflowStateUid string

The uid of the workflow state of the variant group


POST /variantgroups/batch/attributevalues Get attribute values for multiple variant groups

No more than 5000 variant groups can be requested at a time.

Request parameters

Property name Parameter type Data type Description
model body object : VariantGroupValuesRequestModel

Request model

VariantGroupValuesRequestModel
Property name Data type Description
VariantGroupIds array

Ids of variant groups to return

IncludeValues string

Select if any source of values shall be returned

Scopes array

If IncludeValues is Scopes, define which scopes to return values for here

Aliases array

If IncludeValues is Aliases, define aliases of the attributes to include values for

Uids array

If IncludeValues is Uids, define uids of the attributes to include values for

LimitToCultureCodes array

Only return values for specific languages

LimitToSegments array

Only return values for specific dimension segments

GlobalListValueReferencesOnly boolean

Indicate if only uids of referenced to global list values shall be returned instead of the materialized values

FromTimestamp string

Get attribute values back in time

Response status OK (200)

array : VariantGroupAttributeValuesModel
VariantGroupAttributeValuesModel
Property name Data type Description
VariantGroupId integer

Id of variant group

Values object

Dictionary of attribute alias and the corresponding attribute value as an object representation

The table below shows how different attributes translates to this value model.

Attribute type data type
Text attribute string
Number attribute decimal
Boolean attribute bool
Fixedlist attribute value/value[] (depending on whether attribute allows selecting multiple global list values). The datatype of this value model depends on the underlying attribute for the global list of the refernced global list value(s)
Media attribute string/string[] (depending on whether attribute allows selecting multiple medias)
Datetime attribute DateTimeOffset
Category attribute int/int[] (depending on whether attribute allows selecting multiple categories)
Product attribute int/int[] (depending on whether attribute allows selecting multiple products)
Variant attribute int/int[] (depending on whether attribute allows selecting multiple variants)
Collection attribute uuid/uuid[] (depending on whether attribute allows selecting multiple collections)
Attribute attribute string/string[] (depending on whether attribute allows selecting multiple attributes)
Complex attribute object (Each property of the object corresponds to each sub attribute of the complex attribute. The value of each property then corresponds to the data type of that sub attribute)
List attribute value[] (Each value in the array represents each row in the list. The model of each row corresponds to the datatype of the row template set up on the list attribute)

POST /variantgroups/batch/classifications Get category classifications for a batch of variant groups

Request parameters

Property name Parameter type Data type Description
variantGroupIds body array : integer

Model containing batch of variant group ids

Response status OK (200)

object

POST /variantgroups/batch/enrichmentinsights Get Enrichment Insights for a batch of variant groups

Request parameters

Property name Parameter type Data type Description
variantGroupIds body array : integer

Ids of variant groups to get insights for

Response status OK (200)

array : EntityEnrichmentInsight
EntityEnrichmentInsight
Property name Data type Description
EnrichmentInsightSetupUid string

Uid of enrichment insight

EntityId integer

Id of entity

Completeness integer

Completeness in percentage (0 - 100). Is null, if ignored is true

MissingData array : InsightDataReference

List of missing data for this entity to reach 100% completeness for this enrichment insight

Ignored boolean

Indicates whether the completeness is ignored for this entity and this enrichment insight

InsightDataReference
Property name Data type Description
Type string

Type of data reference

DataReference string

The data reference itself


PATCH /variantgroups/batch/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore} Enable or disable an enrichment insight for a batch of variant groups

Request parameters

Property name Parameter type Data type Description
variantGroupIds body array : integer

Ids of variant groups to toggle ignore for

enrichmentInsightSetupUid path string

Uid of enrichment insight to toggle ignore for

ignore path boolean

Indicate whether to ignore the insight for the given enrichment insight and variant groups

Response status OK (200)

No body message is returned

POST /variantgroups/batch/enrichmentinsights/{enrichmentInsightUid} Get insights for a batch of variant groups and a specific Enrichment Insight

Request parameters

Property name Parameter type Data type Description
variantGroupIds body array : integer

Ids of variant groups to get insights for

enrichmentInsightUid path string

Uid of enrichment insight to get for batch of variant groups

Response status OK (200)

array : EntityEnrichmentInsight
EntityEnrichmentInsight
Property name Data type Description
EnrichmentInsightSetupUid string

Uid of enrichment insight

EntityId integer

Id of entity

Completeness integer

Completeness in percentage (0 - 100). Is null, if ignored is true

MissingData array : InsightDataReference

List of missing data for this entity to reach 100% completeness for this enrichment insight

Ignored boolean

Indicates whether the completeness is ignored for this entity and this enrichment insight

InsightDataReference
Property name Data type Description
Type string

Type of data reference

DataReference string

The data reference itself


POST /variantgroups/batch/identifiers Get internal ids of multiple variant groups from their identifier

Request parameters

Property name Parameter type Data type Description
model body object : IdentifierBatchModel

Specify alias of identifier type and the identifiers to return internal ids for

IdentifierBatchModel
Property name Data type Description
IdentifierAlias string

The alias of the identifier

Identifiers array

Array of identifiers to return internal ids for

Response status OK (200)

object

POST /variantgroups/batch/references Get references to a batch of variant groups

No more than 5000 values can be requested at a time.

Request parameters

Property name Parameter type Data type Description
ids body array : integer

Ids of variant groups

Response status OK (200)

array : VariantGroupReferences
VariantGroupReferences
Property name Data type Description
VariantGroupId integer

Id of the referenced variant group

ReferencingCategories array : EntityReferenceDetail

List of categories referencing this variant group

ReferencingProducts array : EntityReferenceDetail

List of products referencing this variant group

ReferencingVariantGroups array : EntityReferenceDetail

List of variant groups referencing this variant group

ReferencingVariants array : EntityReferenceDetail

List of variants referencing this variant group

ReferencingGlobalListValues array

List of global list values referencing this variant group

EntityReferenceDetail
Property name Data type Description
EntityId integer

The id of the referencing entity

AttributeUid string

The attribute on the referencing entity that holds the reference


POST /variantgroups/batch/variants Get ids of variants for a batch of variant groups

Request parameters

Property name Parameter type Data type Description
variantGroupIds body array : integer

Ids of variant groups

includeArchived query boolean

Return ids of archived variants as well

Response status OK (200)

object

POST /variantgroups/classifications Add category classifications to a batch of variant groups

Request parameters

Property name Parameter type Data type Description
classifications body object

Model containing batch og variant groups and categories to classify these in

Response status OK (200)

No body message is returned

DELETE /variantgroups/classifications Remove category classifications from a batch of variant groups

Request parameters

Property name Parameter type Data type Description
model body object

Model containing batch of variant groups and the list of categories to remove them from

Response status OK (200)

No body message is returned

GET /variantgroups/identifiers/{identifierAlias} Get all identifiers and their internal ids for a specific identifier type

Request parameters

Property name Parameter type Data type Description
identifierAlias path string

Alias of identifier type

Response status OK (200)

object

GET /variantgroups/identifiers/{identifierAlias}/{identifier} Get the internal id of a variant group based on its identifier

Request parameters

Property name Parameter type Data type Description
identifierAlias path string

Alias of identifier type

identifier path string

Identifier value

Response status OK (200)

integer

GET /variantgroups/ids Get ids of all variant groups in the system

By default, ids for archived variant groups are not returned

Request parameters

Property name Parameter type Data type Description
includeArchived query boolean

Include archived variant groups

Response status OK (200)

array : integer

GET /variantgroups/queryablefields Get all available query fields in the PIM installation

Response status OK (200)

array : QueryableField
QueryableField
Property name Data type Description
Uid string

Unique id of field in PIM

Name string

The display name of the field

SupportsSorting boolean

If true field can be used for sorting


POST /variantgroups/search Get ids of variant groups matching certain criteria

Request parameters

Property name Parameter type Data type Description
model body object : SearchModel

Query model

SearchModel
Property name Data type Description
IncludeArchived boolean

Include archived items in result

QueryModel object : QueryModel

The actual query to get result for

QueryModel
This model is an abstract type and can attain any of the below concrete models. The QueryModelType property is used to define the actual model type
SimpleQueryModel
Simple query model used for querying specific fields
Property name Data type Description
Filters array : FieldFilterModel

List of filter conditions

BooleanOperator string

The operator of the query. Can be any of:

  • And / 0 (All conditions must match)
  • Or / 1 (At least one of the provided conditions must match)
QueryModelType string

The type of query model. Name matches exact name of concrete model implementation

BooleanQueryModel
Query wrapper for sub queries where the BooleanOperator operates between the sub queries. Allows for nested queries
Property name Data type Description
SubQueries array : QueryModel

Sub queries to execute

BooleanOperator string

The operator of the query. Can be any of:

  • And / 0 (All conditions must match)
  • Or / 1 (At least one of the provided conditions must match)
QueryModelType string

The type of query model. Name matches exact name of concrete model implementation

FieldFilterModel
Property name Data type Description
FieldUid string

Uid of field to query

QueryOperator string

Operator to use for query. Can be any of:

  • Equals / 0 (Value must start with FilterValue)
  • WildcardEquals / 1 (Value must be smaller than FilterValue)
  • SmallerThan / 2 (Value must be smaller than FilterValue)
  • LargerThan / 3 (Value must be larger than FilterValue)
  • IsEmpty / 4 (Value must be empty)
  • IsNotEmpty / 5 (Value must not be empty)
  • Contains / 6 (Value must contain FilterValue)
  • NotContains / 7 (Value must not contain FilterValue)
  • NotEquals / 8 (Value must not be exactly equal to FilterValue (not considering casing))
  • NotWildcardEquals / 9 (Value must not start with FilterValue)
  • InList / 10 (Item field value must match any of the in provided values in FilterList)
FilterValue object

Value to filter for using the QueryOperator. When QueryOperator is "InList", FilterValue must be an array of values to query for

Response status OK (200)

array : integer

POST /variantgroups/search/paged Get paged result of variant groups matching certain criteria. Result mapped with headers and item results

Request parameters

Property name Parameter type Data type Description
model body object : SearchPagedModel

Query model

SearchPagedModel
Property name Data type Description
Page integer
PageSize integer
FieldUids array
SortByFieldUid string
SortDescending boolean
IncludeArchived boolean

Include archived items in result

QueryModel object : QueryModel

The actual query to get result for

QueryModel
This model is an abstract type and can attain any of the below concrete models. The QueryModelType property is used to define the actual model type
SimpleQueryModel
Simple query model used for querying specific fields
Property name Data type Description
Filters array : FieldFilterModel

List of filter conditions

BooleanOperator string

The operator of the query. Can be any of:

  • And / 0 (All conditions must match)
  • Or / 1 (At least one of the provided conditions must match)
QueryModelType string

The type of query model. Name matches exact name of concrete model implementation

BooleanQueryModel
Query wrapper for sub queries where the BooleanOperator operates between the sub queries. Allows for nested queries
Property name Data type Description
SubQueries array : QueryModel

Sub queries to execute

BooleanOperator string

The operator of the query. Can be any of:

  • And / 0 (All conditions must match)
  • Or / 1 (At least one of the provided conditions must match)
QueryModelType string

The type of query model. Name matches exact name of concrete model implementation

FieldFilterModel
Property name Data type Description
FieldUid string

Uid of field to query

QueryOperator string

Operator to use for query. Can be any of:

  • Equals / 0 (Value must start with FilterValue)
  • WildcardEquals / 1 (Value must be smaller than FilterValue)
  • SmallerThan / 2 (Value must be smaller than FilterValue)
  • LargerThan / 3 (Value must be larger than FilterValue)
  • IsEmpty / 4 (Value must be empty)
  • IsNotEmpty / 5 (Value must not be empty)
  • Contains / 6 (Value must contain FilterValue)
  • NotContains / 7 (Value must not contain FilterValue)
  • NotEquals / 8 (Value must not be exactly equal to FilterValue (not considering casing))
  • NotWildcardEquals / 9 (Value must not start with FilterValue)
  • InList / 10 (Item field value must match any of the in provided values in FilterList)
FilterValue object

Value to filter for using the QueryOperator. When QueryOperator is "InList", FilterValue must be an array of values to query for

Response status OK (200)

object : SearchResultModel
SearchResultModel
Property name Data type Description
TotalHits integer
Page integer
PageSize integer
TotalPages integer
ItemListHeaders array : ItemListHeader
ListItems array : ListItem
ItemListHeader
Property name Data type Description
FieldUid string
FieldName string
FieldType string
SupportsSearching boolean
SupportsSorting boolean
ListItem
Property name Data type Description
Id integer
ShownValues array