Resource: getproductgroups.nv
HTTP-method: GET
Note! If you are using Rackbeat inventory management in Netvisor, the API documentation can be found here: https://support.netvisor.fi/en/articles/766869-rackbeat-stoplight-api
The resource can be used to retrieve product group information from Netvisor's API.
Parameters used in query restriction:
Parameter | Occurs | Description | Example |
replyoptions | 0...1 | Include product hierarchy in response, 1 or 0 | 1 |
searchlanguage | 0...1 | Search language, FI, SE or EN | FI |
productgroupnamekeyword | 0...1 | Beginning of the product group hierarchy name | Example |
productgroupnetvisorkeys | 0...1 | NetvisorKey(s) of the product group(s) to be retrieved | 4 |
productgroupnamefreetext | 0...1 | Product group hierarchy name must contain the given text | Example |
Response:
Level | Element | Type | Occurs | Description | Example |
Root | root | Aggregate | 1 |
|
|
1 | ProductGroups | Aggregate | 1 |
|
|
2 | ProductGroup | Aggregate | 1...n |
|
|
3 | NetvisorKey | Numeric | 1 | Product group Netvisor-id | 16 |
3 | ProductGroupNameTranslations | Aggregate | 1 | ||
4 | Translation | String | 1...3 | Product group name | Example product group |
Attr. | Language | String | 1...3 | Language of the product group name | FI |
3 | ProductGroupDescriptionTranslations | Aggregate | 1 | ||
4 | Translation | String | 1...3 | Product group description | Example description |
Attr. | Language | String | 1...3 | Language of the product group description | FI |
3 | ProductGroupHierarchy | Aggregate | 1 | ||
4 | ProductGroupHierarchyNameTranslations | Aggregate | 1 | ||
5 | Translation | String | 1...3 | Product group hierarchy | Example product group / Product group |
Attr. | Language | String | 1...3 | Language of the product group hierarchy | FI |
4 | ParentGroupNetvisorKey | Numeric | 1 | Netvisor-id of the product group whose sub product it is. Can also be empty. | 18 |
4 | ChildGroups | Aggregate | 1 | ||
5 | NetvisorKey | Numeric | 0...n | Netvisor-id:s of the product group's sub product groups | 12 |
This article has been translated using an AI-based translation tool. The contents or wording of these instructions may differ from those in other instructions or in the software.