Struct Docs
Struct.PIM 4
Struct.PIM 4
  • Struct PIM Documentation
  • API Reference
  • Latest updates from Struct HQ
  • Latest updates in Documentation
  • Fundamental concepts
    • Get familiar with Struct PIM
    • Catalogues & categories
    • Products & variants
    • Attributes
    • Product structures
    • Identifiers
    • Global lists
    • Localization & segmentation
    • Revisions & changelog
    • Publications
    • Supplier onboarding portal
  • Tutorials
    • Helpful guides
      • How to search efficiently
      • How to use Import
        • How to import products
        • How to import data into a list property on entities
        • How to import categories
        • How to import with media
        • How to use File templates
    • Example projects
      • Working with the API
  • Integration
    • Integrate with Struct PIM
    • Web API
    • Webhooks
  • Media format
  • API Reference
    • Introduction
    • Endpoints
      • AssetFolders
      • Assets
      • AssetTypes
      • AttributeGroups
      • Attributes
      • AttributeScopes
      • Browse
      • BusinessUnits
      • Catalogues
      • Categories
      • Dimensions
      • Exports
      • EnrichmentInsightSetups
      • GlobalLists
      • Languages
      • Maintenance
      • Miscellaneous
      • Messaging
      • Permissions
      • Products
      • ProductStructures
      • Publications
      • Transactions
      • UserGroup
      • UserRoles
      • Users
      • VariantGroups
      • UserTasks
      • Variants
      • Webhooks
      • Workflows
      • Models
Powered by GitBook
On this page
  1. API Reference
  2. Endpoints

VariantGroups

PreviousUsersNextUserTasks

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 ids of all variant groups in the system

get

By default, ids for archived variant groups are not returned

Authorizations
Query parameters
includeArchivedbooleanOptional

Include archived variant groups

Default: false
Responses
200
OK
Responseinteger · int32[]
get
GET /v1/variantgroups/ids HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  1
]

Get basic model for a variant group

get
Authorizations
Path parameters
idinteger · int32Required

Id of variant group to return

Responses
200
OK
get
GET /v1/variantgroups/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

{
  "Id": 1,
  "Name": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "Created": "2025-05-09T11:23:40.590Z",
  "CreatedBy": "text",
  "LastModified": "2025-05-09T11:23:40.590Z",
  "LastModifiedBy": "text",
  "IsArchived": true,
  "ArchiveReason": "123e4567-e89b-12d3-a456-426614174000",
  "ProductId": 1,
  "SortOrder": 1,
  "WorkflowStateUid": "123e4567-e89b-12d3-a456-426614174000",
  "BusinessUnits": [
    {
      "AccessPolicy": "text",
      "BusinessUnitUid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Delete a variant group

delete
Authorizations
Path parameters
idinteger · int32Required

Id of variant group to delete

Responses
200
OK
delete
DELETE /v1/variantgroups/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

No content

Get basic models for variant groups

get

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

Authorizations
Query parameters
includeArchivedbooleanOptional

Include archived variant groups

Default: false
limitinteger · int32Optional

Number of variant groups to return

Default: 1000
afterIdinteger · int32Optional

Only return variant groups with id larger than this value

Responses
200
OK
get
GET /v1/variantgroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

{
  "VariantGroups": [
    {
      "Id": 1,
      "Name": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "Created": "2025-05-09T11:23:40.590Z",
      "CreatedBy": "text",
      "LastModified": "2025-05-09T11:23:40.590Z",
      "LastModifiedBy": "text",
      "IsArchived": true,
      "ArchiveReason": "123e4567-e89b-12d3-a456-426614174000",
      "ProductId": 1,
      "SortOrder": 1,
      "WorkflowStateUid": "123e4567-e89b-12d3-a456-426614174000",
      "BusinessUnits": [
        {
          "AccessPolicy": "text",
          "BusinessUnitUid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ]
    }
  ],
  "Total": 1,
  "Remaining": 1,
  "LastId": 1
}

Get all identifiers and their internal ids for a specific identifier type

get
Authorizations
Path parameters
identifierAliasstringRequired

Alias of identifier type

Responses
200
OK
get
GET /v1/variantgroups/identifiers/{identifierAlias} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

{
  "ANY_ADDITIONAL_PROPERTY": 1
}

Get the internal id of a variant group based on its identifier

get
Authorizations
Path parameters
identifierAliasstringRequired

Alias of identifier type

identifierstringRequired

Identifier value

Responses
200
OK
Responseinteger · int32
get
GET /v1/variantgroups/identifiers/{identifierAlias}/{identifier} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

1

Get attribute values for a variant group

get
Authorizations
Path parameters
idinteger · int32Required

Id of variant group

Query parameters
globalListValueReferencesOnlybooleanOptional

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

Default: false
Responses
200
OK
404
Not Found
get
GET /v1/variantgroups/{id}/attributevalues HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "VariantGroupId": 1,
  "Values": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get category classifications for a variant group

get
Authorizations
Path parameters
idinteger · int32Required

Id of variant group

Responses
200
OK
get
GET /v1/variantgroups/{id}/classifications HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "CategoryId": 1,
    "OwnerReference": "text",
    "SortOrder": 1
  }
]

Get ids of variants of a variant group

get
Authorizations
Path parameters
idinteger · int32Required

Id of variant group

Query parameters
includeArchivedbooleanOptional

Return ids of archived variants as well

Default: false
Responses
200
OK
Responseinteger · int32[]
get
GET /v1/variantgroups/{id}/variants HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  1
]

Get references to a variant group

get
Authorizations
Path parameters
idinteger · int32Required

Id of variant group

Responses
200
OK
get
GET /v1/variantgroups/{id}/references HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

{
  "VariantGroupId": 1,
  "ReferencingCategories": [
    {
      "EntityId": 1,
      "AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "ReferencingProducts": [
    {
      "EntityId": 1,
      "AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "ReferencingVariantGroups": [
    {
      "EntityId": 1,
      "AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "ReferencingVariants": [
    {
      "EntityId": 1,
      "AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "ReferencingAssets": [
    {
      "EntityId": 1,
      "AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "ReferencingGlobalListValues": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Get all available query fields in the PIM installation

get
Authorizations
Responses
200
OK
get
GET /v1/variantgroups/queryablefields HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "Uid": "text",
    "Name": "text",
    "SupportsSorting": true
  }
]

Get Enrichment Insights for a variant group

get
Authorizations
Path parameters
idinteger · int32Required

Id of variant group to get insights for

Responses
200
OK
get
GET /v1/variantgroups/{id}/enrichmentinsights HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "EnrichmentInsightSetupUid": "123e4567-e89b-12d3-a456-426614174000",
    "EntityId": 1,
    "Completeness": 1,
    "MissingData": [
      {
        "Type": "text",
        "DataReference": "text"
      }
    ],
    "Ignored": true
  }
]

Enable or disable an enrichment insight for a variant group

patch
Authorizations
Path parameters
idinteger · int32Required

Id of variant group

enrichmentInsightSetupUidstring · uuidRequired

Uid of enrichment insight to toggle ignore for

ignorebooleanRequired

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

Responses
200
OK
patch
PATCH /v1/variantgroups/{id}/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

No content
  • GETGet ids of all variant groups in the system
  • GETGet basic model for a variant group
  • DELETEDelete a variant group
  • PATCHUpdate a variant group
  • POSTGet basic model for a range of variant groups
  • GETGet basic models for variant groups
  • POSTCreate new variant groups
  • DELETEDelete multiple variant groups
  • PATCHUpdate multiple variant groups
  • GETGet all identifiers and their internal ids for a specific identifier type
  • GETGet the internal id of a variant group based on its identifier
  • POSTGet internal ids of multiple variant groups from their identifier
  • GETGet attribute values for a variant group
  • POSTGet attribute values for multiple variant groups
  • GETGet category classifications for a variant group
  • POSTAdd category classifications to a variant group
  • DELETERemove category classifications from a variant group
  • POSTGet category classifications for a batch of variant groups
  • POSTAdd category classifications to a batch of variant groups
  • DELETERemove category classifications from a batch of variant groups
  • GETGet ids of variants of a variant group
  • POSTGet ids of variants for a batch of variant groups
  • GETGet references to a variant group
  • POSTGet references to a batch of variant groups
  • POSTGet ids of variant groups matching certain criteria
  • POSTGet paged result of variant groups matching certain criteria. Result mapped with headers and item results
  • GETGet all available query fields in the PIM installation
  • GETGet Enrichment Insights for a variant group
  • POSTGet Enrichment Insights for a batch of variant groups
  • POSTGet insights for a batch of variant groups and a specific Enrichment Insight
  • PATCHEnable or disable an enrichment insight for a variant group
  • PATCHEnable or disable an enrichment insight for a batch of variant groups

Update a variant group

patch
Authorizations
Path parameters
idinteger · int32Required

Id of variant group

Body

Update model containing the updates to make on a variant group. Note that properties with null values will be ignored and will not cause an update. This means you should only set properties that shall be updated on the variant group

IsArchivedboolean | nullableOptional

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

ArchiveReasonstring · uuid | nullableOptional

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

WorkflowStateUidstring · uuid | nullableOptional

Workflow state to set on the variant group

Responses
200
OK
patch
PATCH /v1/variantgroups/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 354

{
  "IsArchived": true,
  "ArchiveReason": "123e4567-e89b-12d3-a456-426614174000",
  "Classifications": [
    {
      "CategoryId": 1,
      "OwnerReference": "text",
      "SortOrder": 1
    }
  ],
  "WorkflowStateUid": "123e4567-e89b-12d3-a456-426614174000",
  "BusinessUnits": [
    {
      "AccessPolicy": "text",
      "BusinessUnitUid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "Values": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
200

OK

No content

Get basic model for a range of variant groups

post
Authorizations
Body
integer · int32[]Optional
Responses
200
OK
post
POST /v1/variantgroups/batch HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 3

[
  1
]
200

OK

[
  {
    "Id": 1,
    "Name": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "Created": "2025-05-09T11:23:40.590Z",
    "CreatedBy": "text",
    "LastModified": "2025-05-09T11:23:40.590Z",
    "LastModifiedBy": "text",
    "IsArchived": true,
    "ArchiveReason": "123e4567-e89b-12d3-a456-426614174000",
    "ProductId": 1,
    "SortOrder": 1,
    "WorkflowStateUid": "123e4567-e89b-12d3-a456-426614174000",
    "BusinessUnits": [
      {
        "AccessPolicy": "text",
        "BusinessUnitUid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }
]

Create new variant groups

post

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

Authorizations
Body

Model used to create a new variant group

ProductIdinteger · int32Optional

Product to associate variant group to

WorkflowStateUidstring · uuid | nullableOptional

Workflow state to set on the variant group

Responses
200
OK
Responseinteger · int32[]
post
POST /v1/variantgroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 297

[
  {
    "ProductId": 1,
    "Classifications": [
      {
        "CategoryId": 1,
        "OwnerReference": "text",
        "SortOrder": 1
      }
    ],
    "WorkflowStateUid": "123e4567-e89b-12d3-a456-426614174000",
    "BusinessUnits": [
      {
        "AccessPolicy": "text",
        "BusinessUnitUid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "Values": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]
200

OK

[
  1
]

Delete multiple variant groups

delete
Authorizations
Body
integer · int32[]Optional
Responses
200
OK
delete
DELETE /v1/variantgroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 3

[
  1
]
200

OK

No content

Update multiple variant groups

patch
Authorizations
Body

Update model for a variant group

VariantGroupIdinteger · int32Optional

Id of variant group to update

Responses
200
OK
patch
PATCH /v1/variantgroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 391

[
  {
    "VariantGroupId": 1,
    "UpdateModel": {
      "IsArchived": true,
      "ArchiveReason": "123e4567-e89b-12d3-a456-426614174000",
      "Classifications": [
        {
          "CategoryId": 1,
          "OwnerReference": "text",
          "SortOrder": 1
        }
      ],
      "WorkflowStateUid": "123e4567-e89b-12d3-a456-426614174000",
      "BusinessUnits": [
        {
          "AccessPolicy": "text",
          "BusinessUnitUid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "Values": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  }
]
200

OK

No content

Get internal ids of multiple variant groups from their identifier

post
Authorizations
Body

Provide an identifier alias along with an array of identifiers to get the internal entity ids matching those identifiers

IdentifierAliasstring | nullableOptional

The alias of the identifier

Identifiersstring[] | nullableOptional

Array of identifiers to return internal ids for

Responses
200
OK
post
POST /v1/variantgroups/batch/identifiers HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 49

{
  "IdentifierAlias": "text",
  "Identifiers": [
    "text"
  ]
}
200

OK

{
  "ANY_ADDITIONAL_PROPERTY": 1
}

Get attribute values for multiple variant groups

post

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

Authorizations
Body

Define which categories to fetch data for and what data to fetch

VariantGroupIdsinteger · int32[] | nullableOptional

Ids of variant groups to return

IncludeValuesinteger · enumOptional

Defines which attribute values to return

Possible values:
Scopesstring[] | nullableOptional

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

Aliasesstring[] | nullableOptional

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

Uidsstring · uuid[] | nullableOptional

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

LimitToCultureCodesstring[] | nullableOptional

Only return values for specific languages

LimitToSegmentsstring[] | nullableOptional

Only return values for specific dimension segments

GlobalListValueReferencesOnlybooleanOptional

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

FromTimestampstring · date-time | nullableOptional

Get attribute values back in time

Responses
200
OK
post
POST /v1/variantgroups/batch/attributevalues HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 264

{
  "VariantGroupIds": [
    1
  ],
  "IncludeValues": 1,
  "Scopes": [
    "text"
  ],
  "Aliases": [
    "text"
  ],
  "Uids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "LimitToCultureCodes": [
    "text"
  ],
  "LimitToSegments": [
    "text"
  ],
  "GlobalListValueReferencesOnly": true,
  "FromTimestamp": "2025-05-09T11:23:40.590Z"
}
200

OK

{
  "VariantGroupId": 1,
  "Values": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Add category classifications to a variant group

post
Authorizations
Path parameters
idinteger · int32Required

Id of variant group

Body

Holds information on variant group placement in categories

CategoryIdinteger · int32Optional

Id of category the variant group is placed in

OwnerReferencestring | nullableOptional

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

SortOrderinteger · int32Optional

Sort order of the variant group in this category

Responses
200
OK
post
POST /v1/variantgroups/{id}/classifications HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 56

[
  {
    "CategoryId": 1,
    "OwnerReference": "text",
    "SortOrder": 1
  }
]
200

OK

No content

Remove category classifications from a variant group

delete
Authorizations
Path parameters
idinteger · int32Required

Id of variant group

Body
integer · int32[]Optional
Responses
200
OK
delete
DELETE /v1/variantgroups/{id}/classifications HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 3

[
  1
]
200

OK

No content

Get category classifications for a batch of variant groups

post
Authorizations
Body
integer · int32[]Optional
Responses
200
OK
post
POST /v1/variantgroups/batch/classifications HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 3

[
  1
]
200

OK

{
  "ANY_ADDITIONAL_PROPERTY": [
    {
      "CategoryId": 1,
      "OwnerReference": "text",
      "SortOrder": 1
    }
  ]
}

Add category classifications to a batch of variant groups

post
Authorizations
Body
Responses
200
OK
post
POST /v1/variantgroups/classifications HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 84

{
  "ANY_ADDITIONAL_PROPERTY": [
    {
      "CategoryId": 1,
      "OwnerReference": "text",
      "SortOrder": 1
    }
  ]
}
200

OK

No content

Remove category classifications from a batch of variant groups

delete
Authorizations
Body
Other propertiesinteger · int32[]Optional
Responses
200
OK
delete
DELETE /v1/variantgroups/classifications HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 31

{
  "ANY_ADDITIONAL_PROPERTY": [
    1
  ]
}
200

OK

No content

Get ids of variants for a batch of variant groups

post
Authorizations
Query parameters
includeArchivedbooleanOptional

Return ids of archived variants as well

Default: false
Body
integer · int32[]Optional
Responses
200
OK
post
POST /v1/variantgroups/batch/variants HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 3

[
  1
]
200

OK

{
  "ANY_ADDITIONAL_PROPERTY": [
    1
  ]
}

Get references to a batch of variant groups

post

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

Authorizations
Body
integer · int32[]Optional
Responses
200
OK
post
POST /v1/variantgroups/batch/references HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 3

[
  1
]
200

OK

[
  {
    "VariantGroupId": 1,
    "ReferencingCategories": [
      {
        "EntityId": 1,
        "AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "ReferencingProducts": [
      {
        "EntityId": 1,
        "AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "ReferencingVariantGroups": [
      {
        "EntityId": 1,
        "AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "ReferencingVariants": [
      {
        "EntityId": 1,
        "AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "ReferencingAssets": [
      {
        "EntityId": 1,
        "AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "ReferencingGlobalListValues": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
]

Get ids of variant groups matching certain criteria

post
Authorizations
Body

Search model used for searching products or variants in PIM

IncludeArchivedbooleanOptional

Include archived items in result

Responses
200
OK
Responseinteger · int32[]
post
POST /v1/variantgroups/search HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 59

{
  "IncludeArchived": true,
  "QueryModel": {
    "BooleanOperator": 0
  }
}
200

OK

[
  1
]

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

post
Authorizations
Body

Extended search model used for searching products or variants in PIM with support for paging and sorting

Pageinteger · int32Optional
PageSizeinteger · int32 | nullableOptional
FieldUidsstring[] | nullableOptional
SortByFieldUidstring | nullableOptional
SortDescendingboolean | nullableOptional
IncludeArchivedbooleanOptional

Include archived items in result

Responses
200
OK
post
POST /v1/variantgroups/search/paged HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 148

{
  "Page": 1,
  "PageSize": 1,
  "FieldUids": [
    "text"
  ],
  "SortByFieldUid": "text",
  "SortDescending": true,
  "IncludeArchived": true,
  "QueryModel": {
    "BooleanOperator": 0
  }
}
200

OK

{
  "TotalHits": 1,
  "Page": 1,
  "PageSize": 1,
  "TotalPages": 1,
  "ItemListHeaders": [
    {
      "FieldUid": "text",
      "FieldName": "text",
      "FieldType": "text",
      "SupportsSearching": true,
      "SupportsSorting": true
    }
  ],
  "ListItems": [
    {
      "Id": 1,
      "ShownValues": [
        "text"
      ]
    }
  ]
}

Get Enrichment Insights for a batch of variant groups

post
Authorizations
Body
integer · int32[]Optional
Responses
200
OK
post
POST /v1/variantgroups/batch/enrichmentinsights HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 3

[
  1
]
200

OK

[
  {
    "EnrichmentInsightSetupUid": "123e4567-e89b-12d3-a456-426614174000",
    "EntityId": 1,
    "Completeness": 1,
    "MissingData": [
      {
        "Type": "text",
        "DataReference": "text"
      }
    ],
    "Ignored": true
  }
]

Get insights for a batch of variant groups and a specific Enrichment Insight

post
Authorizations
Path parameters
enrichmentInsightUidstring · uuidRequired

Uid of enrichment insight to get for batch of variant groups

Body
integer · int32[]Optional
Responses
200
OK
post
POST /v1/variantgroups/batch/enrichmentinsights/{enrichmentInsightUid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 3

[
  1
]
200

OK

[
  {
    "EnrichmentInsightSetupUid": "123e4567-e89b-12d3-a456-426614174000",
    "EntityId": 1,
    "Completeness": 1,
    "MissingData": [
      {
        "Type": "text",
        "DataReference": "text"
      }
    ],
    "Ignored": true
  }
]

Enable or disable an enrichment insight for a batch of variant groups

patch
Authorizations
Path parameters
enrichmentInsightSetupUidstring · uuidRequired

Uid of enrichment insight to toggle ignore for

ignorebooleanRequired

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

Body
integer · int32[]Optional
Responses
200
OK
patch
PATCH /v1/variantgroups/batch/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 3

[
  1
]
200

OK

No content