IntegrationHTTP-methodResourceDTDExample
Get dimension listGETdimensionlist.nv Download
Add and edit dimensionPOSTdimensionitem.nvDownloadDownload 
Hide dimensionPOSTdimensiondelete.nv  

Get dimension list

Recourse: dimensionlist.nv

Retrieves a list of Dimensions.

Parameter nameOccursExampleDescription
showhidden0...1When 1 then also hidden dimension are returned in response

Response:

LevelElement nameType and lengthOccursDescriptionExample
RootRootAggr.1  
1DimensionNameListAggr.1  
2DimensionNameAggr.0...n  
3NetvisorkeyNumeric1Dimension header identifier in Netvisor123
3NameText1Name of the dimension header 
3IsHiddenBoolean1True if dimension header is hidden, otherwise FalseTrue
3LinkTypeNumeric1  
3DimensionDetailsAggr.1Dimensions under dimension header 
4DimensionDetailAggr.0...n  
5NetvisorkeyNumeric1Dimension detail identifier in Netvisor234
5NameText1Name of the dimension detail 
5IsHiddenBoolean1True if dimension detail is hidden, otherwise FalseFalse
5LevelNumeric1Level of the detail dimension5 
5SortNumeric1Dimension number of order. Numbering starts from zero (0). 
5EndSortNumeric1The dimensions last sub-dimensions order number  
5FatheridNumeric1ID of the parent dimension3 

Import and edit dimension

Resource: dimensionitem.nv

Used to add new dimensions and edit existing ones.
Querystring parameters:

ParameterOccursDescriptionExample
method1add or edit. XML determines where new dimension is added in hierarchy or which dimension to editadd
updateparentreference0...1Always true. Used only when editing dimensions, enables changing the dimension hierarchytrue

Request:

LevelElementType and lengthOccursDescriptionExample
RootrootAggr.1  
1dimensionitemAggr.1  
2nameText1Header of the dimension, new dimensions are created under this
Dimension header 
2itemText1Name of the dimension
Dimension
2olditemText0...1If updating existing one, give old name hereDimension
2fatheridNumeric0...1Id of the existing dimension if adding new dimension under existing dimension (hierarchy)0
2fatheritemText0...1Name of the dimensionNew Dimension 
2ishiddenBoolean0...1Is dimension hidden: True or False. True=hidden, False=visibleTrue

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)

Hide dimension

Resource: dimensiondelete.nv

Hides a dimension. Deleting dimensions is not possible via API.

Querystring parameters:

Parameter nameOccursDescriptionExample
dimensionname1Parent dimension of the dimension which to hide
 
dimensionsubname1Name of the dimension to hide 

 


xml
(328 Bytes)
xml

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.