Expand Tree Node
https://server:port/spl/rest/apis/common/system/treeNodes/expandNode
Request
There are no request parameters for this operation.
- application/xml
- application/json
object
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method: * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put -
lastNodeId: number
Minimum Value:
0
Maximum Value:999999999
The highest node identifier used so far for tree node instances. This information is not applicable on the initial call to expand the tree.This is used by the service to generate unique identifiers for the next set of expanded nodes.
-
nodeId: number
Minimum Value:
0
Maximum Value:999999999
The unique identifier of a specific node instance to expand. This information is not applicable on the initial call to expand the tree.This value is generated by the service for each expanded node and should be provided along with the node to expand.
-
nodeName: string
Maximum Length:
30
The node name of the node instance to expand. This information is not applicable on the initial call to expand the tree. -
parentContext: array
parentContext
The context provided by the node's parent node as a way to influence the node's processing rules. The context is represented as a generic list of field names and their values.
For the initial call to this service, use this list to set context for the tree.
-
treeName: string
Maximum Length:
30
The unique name of a tree definition record.
array
For the initial call to this service, use this list to set context for the tree.
object
-
fieldName: string
Maximum Length:
30
Field Name -
value: string
Maximum Length:
4
Field Value
object
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method: * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put -
lastNodeId: number
Minimum Value:
0
Maximum Value:999999999
The highest node identifier used so far for tree node instances. This information is not applicable on the initial call to expand the tree.This is used by the service to generate unique identifiers for the next set of expanded nodes.
-
nodeId: number
Minimum Value:
0
Maximum Value:999999999
The unique identifier of a specific node instance to expand. This information is not applicable on the initial call to expand the tree.This value is generated by the service for each expanded node and should be provided along with the node to expand.
-
nodeName: string
Maximum Length:
30
The node name of the node instance to expand. This information is not applicable on the initial call to expand the tree. -
parentContext: array
parentContext
The context provided by the node's parent node as a way to influence the node's processing rules. The context is represented as a generic list of field names and their values.
For the initial call to this service, use this list to set context for the tree.
-
treeName: string
Maximum Length:
30
The unique name of a tree definition record.
array
For the initial call to this service, use this list to set context for the tree.
object
-
fieldName: string
Maximum Length:
30
Field Name -
value: string
Maximum Length:
4
Field Value
Response
- application/xml
- application/json
200 Response
object
-
applyHeaderStyle: string
Allowed Values:
[ "F1NO", "F1YS" ]
Indicates whether the root nodes of the tree should use a style that emphasizes them compared to other tree nodes. * `F1NO` - No, * `F1YS` - Yes -
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method: * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put -
lastNodeId: number
Minimum Value:
0
Maximum Value:999999999
The highest node identifier used so far for tree node instances. The value should be provided on subsequent calls to expand nodes to ensure node instances are uniquely identified. -
nodes: object
nodes
object
-
expandable: boolean
Indicates that the node is associated with child nodes and therefore may be further expanded.
-
expanded: boolean
Indicates that all immediate child nodes have been expanded and therefore the node may not be further expanded.
-
nodeDetails: object
nodeDetails
-
nodeId: number
Minimum Value:
0
Maximum Value:999999999
The unique identifier of a specific node instance in the tree. This value is generated by the service for each expanded node and should be provided along with the node on a request to expand it. -
nodeName: string
Maximum Length:
30
The node name in the tree definition for this node instance. -
parentNodeId: number
Minimum Value:
0
Maximum Value:999999999
The unique identifier of the node instance's parent in the tree.
object
-
displayDetails: object
displayDetails
-
entity: object
entity
A node typically represents a business entity but it may also be used to provide a summary or grouping of nodes for information purposes.
When the node represents an entity, its name and primary key details are provided to support further flows that may interact with the entity.
-
nodeContext: array
nodeContext
The context set by the node and provided to any of its child nodes when expanded. The context is represented as a generic list of field names and their values.
object
-
badge: array
badge
A list of badges to render along with the node. The text and recommended colors to use are provided for each badge.
-
icon: string
Maximum Length:
254
The name of a standard icon to display for the node. -
nodeText: string
Maximum Length:
2000
The text to display for the node.
object
When the node represents an entity, its name and primary key details are provided to support further flows that may interact with the entity.
-
entityName: string
Maximum Length:
12
Maintenance Object -
pkValue1: string
Maximum Length:
254
Primary Key 1 -
pkValue2: string
Maximum Length:
254
Primary Key 2 -
pkValue3: string
Maximum Length:
254
Primary Key 3 -
pkValue4: string
Maximum Length:
254
Primary Key 4 -
pkValue5: string
Maximum Length:
254
Primary Key 5
array
array
object
-
backgroundColor: string
Maximum Length:
30
Color -
text: string
Maximum Length:
4000
Primary Message -
textColor: string
Maximum Length:
30
Color
object
-
fieldName: string
Maximum Length:
30
Field Name -
value: string
Maximum Length:
4
Field Value
400 Response
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.