Jump to

• Request
• Response

Expand Tree Node

post

/rest/apis/common/system/treeNodes/expandNode

This operation expands a tree node based the tree definition record.

For the initial call to this service, use the parent context list to set the context name and value needed to establish the root node(s) of the tree.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "treeName":{
            "type":"string",
            "maxLength":"30",
            "description":"The unique name of a tree definition record."
        },
        "nodeName":{
            "type":"string",
            "maxLength":"30",
            "description":"The node name of the node instance to expand. This information is not applicable on the initial call to expand the tree."
        },
        "nodeId":{
            "type":"number",
            "maximum":"999999999",
            "minimum":"0",
            "description":"The unique identifier of a specific node instance to expand. This information is not applicable on the initial call to expand the tree. \n<p>\nThis value is generated by the service for each expanded node and should be provided along with the node to expand."
        },
        "lastNodeId":{
            "type":"number",
            "maximum":"999999999",
            "minimum":"0",
            "description":"The highest node identifier used so far for tree node instances. This information is not applicable on the initial call to expand the tree. \n<p>\nThis is used by the service to generate unique identifiers for the next set of expanded nodes."
        },
        "parentContext":{
            "type":"array",
            "description":"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. \n<p>\nFor the initial call to this service, use this list to set context for the tree.",
            "items":{
                "type":"object",
                "properties":{
                    "fieldName":{
                        "type":"string",
                        "maxLength":"30",
                        "description":"Field Name"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":"50",
                        "description":"PK Value"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"F1ExpandTree"
    }
}

Nested Schema : parentContext

Type: array

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.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"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. \n<p>\nFor the initial call to this service, use this list to set context for the tree.",
    "items":{
        "type":"object",
        "properties":{
            "fieldName":{
                "type":"string",
                "maxLength":"30",
                "description":"Field Name"
            },
            "value":{
                "type":"string",
                "maxLength":"50",
                "description":"PK Value"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• fieldName: string
  Maximum Length: 30

  Field Name
• value: string
  Maximum Length: 50

  PK Value

{
    "type":"object",
    "properties":{
        "fieldName":{
            "type":"string",
            "maxLength":"30",
            "description":"Field Name"
        },
        "value":{
            "type":"string",
            "maxLength":"50",
            "description":"PK Value"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "treeName":{
            "type":"string",
            "maxLength":"30",
            "description":"The unique name of a tree definition record."
        },
        "nodeName":{
            "type":"string",
            "maxLength":"30",
            "description":"The node name of the node instance to expand. This information is not applicable on the initial call to expand the tree."
        },
        "nodeId":{
            "type":"number",
            "maximum":"999999999",
            "minimum":"0",
            "description":"The unique identifier of a specific node instance to expand. This information is not applicable on the initial call to expand the tree. \n<p>\nThis value is generated by the service for each expanded node and should be provided along with the node to expand."
        },
        "lastNodeId":{
            "type":"number",
            "maximum":"999999999",
            "minimum":"0",
            "description":"The highest node identifier used so far for tree node instances. This information is not applicable on the initial call to expand the tree. \n<p>\nThis is used by the service to generate unique identifiers for the next set of expanded nodes."
        },
        "parentContext":{
            "type":"array",
            "description":"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. \n<p>\nFor the initial call to this service, use this list to set context for the tree.",
            "items":{
                "type":"object",
                "properties":{
                    "fieldName":{
                        "type":"string",
                        "maxLength":"30",
                        "description":"Field Name"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":"50",
                        "description":"PK Value"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"F1ExpandTree"
    }
}

Nested Schema : parentContext

Type: array

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.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"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. \n<p>\nFor the initial call to this service, use this list to set context for the tree.",
    "items":{
        "type":"object",
        "properties":{
            "fieldName":{
                "type":"string",
                "maxLength":"30",
                "description":"Field Name"
            },
            "value":{
                "type":"string",
                "maxLength":"50",
                "description":"PK Value"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• fieldName: string
  Maximum Length: 30

  Field Name
• value: string
  Maximum Length: 50

  PK Value

{
    "type":"object",
    "properties":{
        "fieldName":{
            "type":"string",
            "maxLength":"30",
            "description":"Field Name"
        },
        "value":{
            "type":"string",
            "maxLength":"50",
            "description":"PK Value"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : F1ExpandTree

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "lastNodeId":{
            "type":"number",
            "maximum":"999999999",
            "minimum":"0",
            "description":"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."
        },
        "applyHeaderStyle":{
            "type":"string",
            "enum":[
                "F1NO",
                "F1YS"
            ],
            "description":"Indicates whether the root nodes of the tree should use a style that emphasizes them compared to other tree nodes.\n* `F1NO` - No,\n* `F1YS` - Yes"
        },
        "nodes":{
            "type":"object",
            "properties":{
                "node":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "parentNodeId":{
                                "type":"number",
                                "maximum":"999999999",
                                "minimum":"0",
                                "description":"The unique identifier of the node instance's parent in the tree."
                            },
                            "nodeId":{
                                "type":"number",
                                "maximum":"999999999",
                                "minimum":"0",
                                "description":"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":{
                                "type":"string",
                                "maxLength":"30",
                                "description":"The node name in the tree definition for this node instance."
                            },
                            "expandable":{
                                "type":"boolean",
                                "description":"Indicates that the node is associated with child nodes and therefore may be further expanded."
                            },
                            "expanded":{
                                "type":"boolean",
                                "description":"Indicates that all immediate child nodes have been expanded and therefore the node may not be further expanded."
                            },
                            "nodeDetails":{
                                "type":"object",
                                "properties":{
                                    "entity":{
                                        "type":"object",
                                        "description":"A node typically represents a business entity but it may also be used to provide a summary or grouping of nodes for information purposes. \n<p>\nWhen the node represents an entity, its name and primary key details are provided to support further flows that may interact with the entity.\n</p>",
                                        "properties":{
                                            "entityName":{
                                                "type":"string",
                                                "maxLength":"12",
                                                "description":"Maintenance Object"
                                            },
                                            "pkValue1":{
                                                "type":"string",
                                                "maxLength":"254",
                                                "description":"Primary Key 1"
                                            },
                                            "pkValue2":{
                                                "type":"string",
                                                "maxLength":"254",
                                                "description":"Primary Key 2"
                                            },
                                            "pkValue3":{
                                                "type":"string",
                                                "maxLength":"254",
                                                "description":"Primary Key 3"
                                            },
                                            "pkValue4":{
                                                "type":"string",
                                                "maxLength":"254",
                                                "description":"Primary Key 4"
                                            },
                                            "pkValue5":{
                                                "type":"string",
                                                "maxLength":"254",
                                                "description":"Primary Key 5"
                                            }
                                        }
                                    },
                                    "displayDetails":{
                                        "type":"object",
                                        "properties":{
                                            "icon":{
                                                "type":"string",
                                                "maxLength":"254",
                                                "description":"The name of a standard icon to display for the node."
                                            },
                                            "nodeText":{
                                                "type":"string",
                                                "maxLength":"2000",
                                                "description":"The text to display for the node."
                                            },
                                            "badge":{
                                                "type":"array",
                                                "description":"A list of badges to render along with the node. The text and recommended colors to use are provided for each badge.",
                                                "items":{
                                                    "type":"object",
                                                    "properties":{
                                                        "text":{
                                                            "type":"string",
                                                            "maxLength":"4000",
                                                            "description":"Primary Message"
                                                        },
                                                        "textColor":{
                                                            "type":"string",
                                                            "maxLength":"30",
                                                            "description":"Color"
                                                        },
                                                        "backgroundColor":{
                                                            "type":"string",
                                                            "maxLength":"30",
                                                            "description":"Color"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "nodeContext":{
                                        "type":"array",
                                        "description":"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.",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "fieldName":{
                                                    "type":"string",
                                                    "maxLength":"30",
                                                    "description":"Field Name"
                                                },
                                                "value":{
                                                    "type":"string",
                                                    "maxLength":"50",
                                                    "description":"PK Value"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"F1ExpandTree"
    }
}

Nested Schema : nodes

Type: object

Show Source

• node: array node

{
    "type":"object",
    "properties":{
        "node":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "parentNodeId":{
                        "type":"number",
                        "maximum":"999999999",
                        "minimum":"0",
                        "description":"The unique identifier of the node instance's parent in the tree."
                    },
                    "nodeId":{
                        "type":"number",
                        "maximum":"999999999",
                        "minimum":"0",
                        "description":"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":{
                        "type":"string",
                        "maxLength":"30",
                        "description":"The node name in the tree definition for this node instance."
                    },
                    "expandable":{
                        "type":"boolean",
                        "description":"Indicates that the node is associated with child nodes and therefore may be further expanded."
                    },
                    "expanded":{
                        "type":"boolean",
                        "description":"Indicates that all immediate child nodes have been expanded and therefore the node may not be further expanded."
                    },
                    "nodeDetails":{
                        "type":"object",
                        "properties":{
                            "entity":{
                                "type":"object",
                                "description":"A node typically represents a business entity but it may also be used to provide a summary or grouping of nodes for information purposes. \n<p>\nWhen the node represents an entity, its name and primary key details are provided to support further flows that may interact with the entity.\n</p>",
                                "properties":{
                                    "entityName":{
                                        "type":"string",
                                        "maxLength":"12",
                                        "description":"Maintenance Object"
                                    },
                                    "pkValue1":{
                                        "type":"string",
                                        "maxLength":"254",
                                        "description":"Primary Key 1"
                                    },
                                    "pkValue2":{
                                        "type":"string",
                                        "maxLength":"254",
                                        "description":"Primary Key 2"
                                    },
                                    "pkValue3":{
                                        "type":"string",
                                        "maxLength":"254",
                                        "description":"Primary Key 3"
                                    },
                                    "pkValue4":{
                                        "type":"string",
                                        "maxLength":"254",
                                        "description":"Primary Key 4"
                                    },
                                    "pkValue5":{
                                        "type":"string",
                                        "maxLength":"254",
                                        "description":"Primary Key 5"
                                    }
                                }
                            },
                            "displayDetails":{
                                "type":"object",
                                "properties":{
                                    "icon":{
                                        "type":"string",
                                        "maxLength":"254",
                                        "description":"The name of a standard icon to display for the node."
                                    },
                                    "nodeText":{
                                        "type":"string",
                                        "maxLength":"2000",
                                        "description":"The text to display for the node."
                                    },
                                    "badge":{
                                        "type":"array",
                                        "description":"A list of badges to render along with the node. The text and recommended colors to use are provided for each badge.",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "text":{
                                                    "type":"string",
                                                    "maxLength":"4000",
                                                    "description":"Primary Message"
                                                },
                                                "textColor":{
                                                    "type":"string",
                                                    "maxLength":"30",
                                                    "description":"Color"
                                                },
                                                "backgroundColor":{
                                                    "type":"string",
                                                    "maxLength":"30",
                                                    "description":"Color"
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "nodeContext":{
                                "type":"array",
                                "description":"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.",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "fieldName":{
                                            "type":"string",
                                            "maxLength":"30",
                                            "description":"Field Name"
                                        },
                                        "value":{
                                            "type":"string",
                                            "maxLength":"50",
                                            "description":"PK Value"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : node

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "parentNodeId":{
                "type":"number",
                "maximum":"999999999",
                "minimum":"0",
                "description":"The unique identifier of the node instance's parent in the tree."
            },
            "nodeId":{
                "type":"number",
                "maximum":"999999999",
                "minimum":"0",
                "description":"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":{
                "type":"string",
                "maxLength":"30",
                "description":"The node name in the tree definition for this node instance."
            },
            "expandable":{
                "type":"boolean",
                "description":"Indicates that the node is associated with child nodes and therefore may be further expanded."
            },
            "expanded":{
                "type":"boolean",
                "description":"Indicates that all immediate child nodes have been expanded and therefore the node may not be further expanded."
            },
            "nodeDetails":{
                "type":"object",
                "properties":{
                    "entity":{
                        "type":"object",
                        "description":"A node typically represents a business entity but it may also be used to provide a summary or grouping of nodes for information purposes. \n<p>\nWhen the node represents an entity, its name and primary key details are provided to support further flows that may interact with the entity.\n</p>",
                        "properties":{
                            "entityName":{
                                "type":"string",
                                "maxLength":"12",
                                "description":"Maintenance Object"
                            },
                            "pkValue1":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Primary Key 1"
                            },
                            "pkValue2":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Primary Key 2"
                            },
                            "pkValue3":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Primary Key 3"
                            },
                            "pkValue4":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Primary Key 4"
                            },
                            "pkValue5":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Primary Key 5"
                            }
                        }
                    },
                    "displayDetails":{
                        "type":"object",
                        "properties":{
                            "icon":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"The name of a standard icon to display for the node."
                            },
                            "nodeText":{
                                "type":"string",
                                "maxLength":"2000",
                                "description":"The text to display for the node."
                            },
                            "badge":{
                                "type":"array",
                                "description":"A list of badges to render along with the node. The text and recommended colors to use are provided for each badge.",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "text":{
                                            "type":"string",
                                            "maxLength":"4000",
                                            "description":"Primary Message"
                                        },
                                        "textColor":{
                                            "type":"string",
                                            "maxLength":"30",
                                            "description":"Color"
                                        },
                                        "backgroundColor":{
                                            "type":"string",
                                            "maxLength":"30",
                                            "description":"Color"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "nodeContext":{
                        "type":"array",
                        "description":"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.",
                        "items":{
                            "type":"object",
                            "properties":{
                                "fieldName":{
                                    "type":"string",
                                    "maxLength":"30",
                                    "description":"Field Name"
                                },
                                "value":{
                                    "type":"string",
                                    "maxLength":"50",
                                    "description":"PK Value"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "parentNodeId":{
            "type":"number",
            "maximum":"999999999",
            "minimum":"0",
            "description":"The unique identifier of the node instance's parent in the tree."
        },
        "nodeId":{
            "type":"number",
            "maximum":"999999999",
            "minimum":"0",
            "description":"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":{
            "type":"string",
            "maxLength":"30",
            "description":"The node name in the tree definition for this node instance."
        },
        "expandable":{
            "type":"boolean",
            "description":"Indicates that the node is associated with child nodes and therefore may be further expanded."
        },
        "expanded":{
            "type":"boolean",
            "description":"Indicates that all immediate child nodes have been expanded and therefore the node may not be further expanded."
        },
        "nodeDetails":{
            "type":"object",
            "properties":{
                "entity":{
                    "type":"object",
                    "description":"A node typically represents a business entity but it may also be used to provide a summary or grouping of nodes for information purposes. \n<p>\nWhen the node represents an entity, its name and primary key details are provided to support further flows that may interact with the entity.\n</p>",
                    "properties":{
                        "entityName":{
                            "type":"string",
                            "maxLength":"12",
                            "description":"Maintenance Object"
                        },
                        "pkValue1":{
                            "type":"string",
                            "maxLength":"254",
                            "description":"Primary Key 1"
                        },
                        "pkValue2":{
                            "type":"string",
                            "maxLength":"254",
                            "description":"Primary Key 2"
                        },
                        "pkValue3":{
                            "type":"string",
                            "maxLength":"254",
                            "description":"Primary Key 3"
                        },
                        "pkValue4":{
                            "type":"string",
                            "maxLength":"254",
                            "description":"Primary Key 4"
                        },
                        "pkValue5":{
                            "type":"string",
                            "maxLength":"254",
                            "description":"Primary Key 5"
                        }
                    }
                },
                "displayDetails":{
                    "type":"object",
                    "properties":{
                        "icon":{
                            "type":"string",
                            "maxLength":"254",
                            "description":"The name of a standard icon to display for the node."
                        },
                        "nodeText":{
                            "type":"string",
                            "maxLength":"2000",
                            "description":"The text to display for the node."
                        },
                        "badge":{
                            "type":"array",
                            "description":"A list of badges to render along with the node. The text and recommended colors to use are provided for each badge.",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "text":{
                                        "type":"string",
                                        "maxLength":"4000",
                                        "description":"Primary Message"
                                    },
                                    "textColor":{
                                        "type":"string",
                                        "maxLength":"30",
                                        "description":"Color"
                                    },
                                    "backgroundColor":{
                                        "type":"string",
                                        "maxLength":"30",
                                        "description":"Color"
                                    }
                                }
                            }
                        }
                    }
                },
                "nodeContext":{
                    "type":"array",
                    "description":"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.",
                    "items":{
                        "type":"object",
                        "properties":{
                            "fieldName":{
                                "type":"string",
                                "maxLength":"30",
                                "description":"Field Name"
                            },
                            "value":{
                                "type":"string",
                                "maxLength":"50",
                                "description":"PK Value"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : nodeDetails

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "entity":{
            "type":"object",
            "description":"A node typically represents a business entity but it may also be used to provide a summary or grouping of nodes for information purposes. \n<p>\nWhen the node represents an entity, its name and primary key details are provided to support further flows that may interact with the entity.\n</p>",
            "properties":{
                "entityName":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Maintenance Object"
                },
                "pkValue1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Primary Key 1"
                },
                "pkValue2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Primary Key 2"
                },
                "pkValue3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Primary Key 3"
                },
                "pkValue4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Primary Key 4"
                },
                "pkValue5":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Primary Key 5"
                }
            }
        },
        "displayDetails":{
            "type":"object",
            "properties":{
                "icon":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The name of a standard icon to display for the node."
                },
                "nodeText":{
                    "type":"string",
                    "maxLength":"2000",
                    "description":"The text to display for the node."
                },
                "badge":{
                    "type":"array",
                    "description":"A list of badges to render along with the node. The text and recommended colors to use are provided for each badge.",
                    "items":{
                        "type":"object",
                        "properties":{
                            "text":{
                                "type":"string",
                                "maxLength":"4000",
                                "description":"Primary Message"
                            },
                            "textColor":{
                                "type":"string",
                                "maxLength":"30",
                                "description":"Color"
                            },
                            "backgroundColor":{
                                "type":"string",
                                "maxLength":"30",
                                "description":"Color"
                            }
                        }
                    }
                }
            }
        },
        "nodeContext":{
            "type":"array",
            "description":"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.",
            "items":{
                "type":"object",
                "properties":{
                    "fieldName":{
                        "type":"string",
                        "maxLength":"30",
                        "description":"Field Name"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":"50",
                        "description":"PK Value"
                    }
                }
            }
        }
    }
}

Nested Schema : displayDetails

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "icon":{
            "type":"string",
            "maxLength":"254",
            "description":"The name of a standard icon to display for the node."
        },
        "nodeText":{
            "type":"string",
            "maxLength":"2000",
            "description":"The text to display for the node."
        },
        "badge":{
            "type":"array",
            "description":"A list of badges to render along with the node. The text and recommended colors to use are provided for each badge.",
            "items":{
                "type":"object",
                "properties":{
                    "text":{
                        "type":"string",
                        "maxLength":"4000",
                        "description":"Primary Message"
                    },
                    "textColor":{
                        "type":"string",
                        "maxLength":"30",
                        "description":"Color"
                    },
                    "backgroundColor":{
                        "type":"string",
                        "maxLength":"30",
                        "description":"Color"
                    }
                }
            }
        }
    }
}

Nested Schema : entity

Type: object

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.

Show Source

• 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

{
    "type":"object",
    "description":"A node typically represents a business entity but it may also be used to provide a summary or grouping of nodes for information purposes. \n<p>\nWhen the node represents an entity, its name and primary key details are provided to support further flows that may interact with the entity.\n</p>",
    "properties":{
        "entityName":{
            "type":"string",
            "maxLength":"12",
            "description":"Maintenance Object"
        },
        "pkValue1":{
            "type":"string",
            "maxLength":"254",
            "description":"Primary Key 1"
        },
        "pkValue2":{
            "type":"string",
            "maxLength":"254",
            "description":"Primary Key 2"
        },
        "pkValue3":{
            "type":"string",
            "maxLength":"254",
            "description":"Primary Key 3"
        },
        "pkValue4":{
            "type":"string",
            "maxLength":"254",
            "description":"Primary Key 4"
        },
        "pkValue5":{
            "type":"string",
            "maxLength":"254",
            "description":"Primary Key 5"
        }
    }
}

Nested Schema : nodeContext

Type: array

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.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"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.",
    "items":{
        "type":"object",
        "properties":{
            "fieldName":{
                "type":"string",
                "maxLength":"30",
                "description":"Field Name"
            },
            "value":{
                "type":"string",
                "maxLength":"50",
                "description":"PK Value"
            }
        }
    }
}

Nested Schema : badge

Type: array

A list of badges to render along with the node. The text and recommended colors to use are provided for each badge.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"A list of badges to render along with the node. The text and recommended colors to use are provided for each badge.",
    "items":{
        "type":"object",
        "properties":{
            "text":{
                "type":"string",
                "maxLength":"4000",
                "description":"Primary Message"
            },
            "textColor":{
                "type":"string",
                "maxLength":"30",
                "description":"Color"
            },
            "backgroundColor":{
                "type":"string",
                "maxLength":"30",
                "description":"Color"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• backgroundColor: string
  Maximum Length: 30

  Color
• text: string
  Maximum Length: 4000

  Primary Message
• textColor: string
  Maximum Length: 30

  Color

{
    "type":"object",
    "properties":{
        "text":{
            "type":"string",
            "maxLength":"4000",
            "description":"Primary Message"
        },
        "textColor":{
            "type":"string",
            "maxLength":"30",
            "description":"Color"
        },
        "backgroundColor":{
            "type":"string",
            "maxLength":"30",
            "description":"Color"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• fieldName: string
  Maximum Length: 30

  Field Name
• value: string
  Maximum Length: 50

  PK Value

{
    "type":"object",
    "properties":{
        "fieldName":{
            "type":"string",
            "maxLength":"30",
            "description":"Field Name"
        },
        "value":{
            "type":"string",
            "maxLength":"50",
            "description":"PK Value"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":"60",
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":"9999",
            "minimum":"0",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":"60",
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":"60",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":"0",
                    "minimum":"0",
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":"99999",
                    "minimum":"-99999",
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":"0",
            "minimum":"0",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":"60",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":"60",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":"60",
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":"9999",
            "minimum":"0",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":"60",
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":"60",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":"0",
                    "minimum":"0",
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":"99999",
                    "minimum":"-99999",
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":"0",
            "minimum":"0",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":"60",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":"60",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top