Resources - Dimensions

Integration	HTTP-method	Resource	DTD	Example
Get dimension list	GET	dimensionlist.nv		Download
Add and edit dimension	POST	dimensionitem.nv	Download	Download
Hide dimension	POST	dimensiondelete.nv

Get dimension list

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

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
3	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

Import and edit dimension

Resource: dimensionitem.nv

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

Parameter	Occurs	Description	Example
method	1	add or edit. XML determines where new dimension is added in hierarchy or which dimension to edit	add
updateparentreference	0...1	Always true. Used only when editing dimensions, enables changing the dimension hierarchy	true

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)

Hide dimension

Resource: dimensiondelete.nv

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

Querystring parameters:

Parameter name	Occurs	Description	Example
dimensionname	1	Parent dimension of the dimension which to hide
dimensionsubname	1	Name of the dimension to hide

 

Did you find it helpful? Yes No

Send feedback