Integration | HTTP-method | Resource | DTD | Example |
Get dimension list | GET | dimensionlist.nv | Download | |
Add and edit dimension | POST | dimensionitem.nv | Download | Download |
Delete dimension | POST | dimensiondelete.nv |
Recourse: dimensionlist.nv
Retrieves a list of Dimensions.
Parameter name | Occurs | Example | Description |
showhidden | 0...1 | When 1 then also hidden dimension are returned in response | 1 |
Response:
Level | Element name | Type and length | Occurs | Description | Example |
Root | root | Aggr. | 1 | ||
1 | DimensionNameList | Aggr. | 1 | ||
2 | DimensionName | Aggr. | 0...n | ||
3 | NetvisorKey | Numeric | 1 | Dimension header identifier in Netvisor | 123 |
3 | Name | Text | 1 | Name of the dimension header | |
IsHidden | Boolean | 1 | True if dimension header is hidden, otherwise False | True | |
3 | LinkType | Numeric | 1 | ||
3 | DimensionDetails | Aggr. | 1 | Dimensions under dimension header | |
4 | DimensionDetail | Aggr. | 0...n | ||
5 | NetvisorKey | Numeric | 1 | Dimension detail identifier in Netvisor | 234 |
5 | Name | Text | 1 | Name of the dimension detail | |
5 | IsHidden | Boolean | 1 | True if dimension detail is hidden, otherwise False | False |
5 | Level | Numeric | 1 | Level of the detail dimension | 5 |
5 | Sort | Numeric | 1 | Dimension number of order. Numbering starts from zero (0). | |
5 | EndSort | Numeric | 1 | The dimensions last sub-dimensions order number | |
5 | FatherID | Numeric | 1 | ID of the parent dimension | 3 |
Resource: dimensionitem.nv
Used to add new dimensions and edit existing ones.
Querystring parameters:
Parameter | Occurs | Description | Example |
method | add or edit | XML determines where new dimension is added in hierarchy or which dimension to edit | add |
Request:
Level | Element | Type and length | Occurs | Description | Example |
Root | root | Aggr. | 1 | ||
1 | dimensionitem | Aggr. | 1 | ||
2 | name | Text | 1 | Header of the dimension, new dimensions are created under this | Dimension header |
2 | item | Text | 1 | Name of the dimension | Dimension |
2 | olditem | Text | 0...1 | If updating existing one, give old name here | Dimension |
2 | fatherid | Numeric | 0...1 | Id of the existing dimension if adding new dimension under existing dimension (hierarchy) | 0 |
2 | fatheritem | Text | 0...1 | Name of the dimension | New Dimension |
2 | ishidden | Boolean | 0...1 | Is dimension hidden: True or False. True=hidden, False=visible | True |
Notes when adding and editing dimensions:
- Aggregates Fatherid and Fathername are mandatory when new dimension is added in hierarchy (under existing dimension)
- Aggregate Olditem is mandatory when editing existing dimension (no matter where in hierarchy it is)
Resource: dimensiondelete.nv
Deletes a dimension.
Querystring parameters:
Parameter name | Occurs | Description | Example |
DimensionName | 1 | Parent dimension of the dimension which to delete | |
DimensionSubName | 1 | Name of the dimension to delete |
Did you find it helpful? Yes No
Send feedback