peoplecodeapi - GetABNReqParameters

Syntax

GetABNReqParameters([start])

Description

Note: SmartNavigation has been deprecated. This function remains for backward compatibility only.

Use this function to generate HTTP request parameters as an array of name-value pairs. The start parameter specifies the initial node of the data source. When using a tree data source, the start parameter is optional. If the initial node is not provided, the tree's root node is the initial node.

When using a rowset data source, the start parameter is required. The returned request parameter array contains the following values:

Array Element	HTTP Request Parameter Name/Value
[1][1] [1][2]	TREE_NAME The tree's name.*
[2][1] [2][2]	TREE_SETID The tree's setID key.*
[3][1] [3][2]	TREE_USERKEY The tree's user key.*
[4][1] [4][2]	TREE_EFFDT The tree's effective date key.*
[5][1] [5][2]	TREE_NODE The name of the currently requested tree node.*
[6][1] [6][2]	INITIAL_TREE_NODE The name of the initial node.

Array Element

HTTP Request Parameter Name/Value

[1][1]

[1][2]

TREE_NAME

The tree's name.*

[2][1]

[2][2]

TREE_SETID

The tree's setID key.*

[3][1]

[3][2]

TREE_USERKEY

The tree's user key.*

[4][1]

[4][2]

TREE_EFFDT

The tree's effective date key.*

[5][1]

[5][2]

TREE_NODE

The name of the currently requested tree node.*

[6][1]

[6][2]

INITIAL_TREE_NODE

The name of the initial node.

* Set to an empty string when the data source is a rowset.

Parameters

Field or Control	Definition
`start`	Specifies a string representing the initial node of the tree or rowset data source.

Returns

An array of array of string representing the HTTP request parameters (name-value pairs).