Jump to

• Request
• Response

Retrieve diagnostic tree node data by keyword search

post

/custom-actions/diagnosticTreeNodeByKeyword

Returns the diagnostic tree node details for given matching search keyword. A search is conducted on entire node data, like status, remarks, process name, and entities.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• diagnosticLogFileId(required): string
  The diagnostic log file identifier.
• filterMap: object filterMap

{
    "properties":{
        "diagnosticLogFileId":{
            "type":"string",
            "description":"The diagnostic log file identifier."
        },
        "filterMap":{
            "type":"object",
            "properties":{
                "searchKeyword":{
                    "type":"string",
                    "description":"The search keyword in diagnostic tree nodes. The search is conducted on the entire node data like status, remarks, process name, and so on.",
                    "example":"multistop"
                }
            },
            "required":[
                "searchKeyword"
            ]
        }
    },
    "required":[
        "diagnosticLogFileId"
    ]
}

Nested Schema : filterMap

Type: object

Show Source

• searchKeyword(required): string
  The search keyword in diagnostic tree nodes. The search is conducted on the entire node data like status, remarks, process name, and so on.

  Example: multistop

{
    "type":"object",
    "properties":{
        "searchKeyword":{
            "type":"string",
            "description":"The search keyword in diagnostic tree nodes. The search is conducted on the entire node data like status, remarks, process name, and so on.",
            "example":"multistop"
        }
    },
    "required":[
        "searchKeyword"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The successful response.

Body ()

Root Schema : DiagnosticTreeNodeByKeywordResponse

Type: object

Show Source

• actualDepth(required): integer
  The total depth of the given diagnostic tree data.
• completeTree(required): boolean
• reason: string
  Shows the error reason in the case where the matched tree node is larger in size.
• requestedDepth(required): integer
  The requested depth of the tree. This represents the depth parameter in the rest request.
• returnedDepth(required): integer
  The eturned depth of the tree.
• status(required): string
  The status of the process: SUCCESS or FAILURE.
• tree(required): TreeNode

{
    "properties":{
        "actualDepth":{
            "type":"integer",
            "description":"The total depth of the given diagnostic tree data."
        },
        "completeTree":{
            "type":"boolean"
        },
        "reason":{
            "type":"string",
            "description":"Shows the error reason in the case where the matched tree node is larger in size."
        },
        "requestedDepth":{
            "type":"integer",
            "description":"The requested depth of the tree. This represents the depth parameter in the rest request."
        },
        "returnedDepth":{
            "type":"integer",
            "description":"The eturned depth of the tree."
        },
        "status":{
            "type":"string",
            "description":"The status of the process: SUCCESS or FAILURE."
        },
        "tree":{
            "$ref":"#/components/schemas/TreeNode",
            "description":"The matched tree data. This will be null if there are no matching nodes or if the matched node size is above the configured size."
        }
    },
    "required":[
        "actualDepth",
        "completeTree",
        "requestedDepth",
        "returnedDepth",
        "status",
        "tree"
    ]
}

Nested Schema : TreeNode

Type: object

Show Source

• childIds: array childIds
  The list of child node IDs.
• children: array children
  The recursive child nodes.
• duration: string
  The execution duration, e.g., '35.35S'
• entities: object entities
  Additional Properties Allowed: additionalProperties

  The dynamic entity map keys, like ORDER_RELEASE, BULK_PLAN, etc.
• exportFiles: array exportFiles
  The list of file names like conoptData1.xml, conoptData2.xml, etc.
• id: string
  The ID of the diagnostic tree node.
• isList: boolean
• nonDBEntities: array nonDBEntities
• processType: string
  The name of the current process that the node represents.
• reasonCodeList: array reasonCodeList
• remarks: array remarks
• status: string
  The status of the process. It could be SUCCESS, FAILURE, ERROR, and so on.

{
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the diagnostic tree node."
        },
        "status":{
            "type":"string",
            "description":"The status of the process. It could be SUCCESS, FAILURE, ERROR, and so on."
        },
        "processType":{
            "type":"string",
            "description":"The name of the current process that the node represents."
        },
        "duration":{
            "type":"string",
            "description":"The execution duration, e.g., '35.35S'"
        },
        "isList":{
            "type":"boolean"
        },
        "childIds":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"The list of child node IDs."
        },
        "children":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TreeNode"
            },
            "description":"The recursive child nodes."
        },
        "entities":{
            "type":"object",
            "description":"The dynamic entity map keys, like ORDER_RELEASE, BULK_PLAN, etc.",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "nonDBEntities":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "reasonCodeList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "remarks":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "exportFiles":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"The list of file names like conoptData1.xml, conoptData2.xml, etc."
        }
    }
}

Nested Schema : childIds

Type: array

The list of child node IDs.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"The list of child node IDs."
}

Nested Schema : children

Type: array

The recursive child nodes.

Show Source

• Array of: object TreeNode

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TreeNode"
    },
    "description":"The recursive child nodes."
}

Nested Schema : entities

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "description":"The dynamic entity map keys, like ORDER_RELEASE, BULK_PLAN, etc.",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

The dynamic entity map keys, like ORDER_RELEASE, BULK_PLAN, etc.

Nested Schema : exportFiles

Type: array

The list of file names like conoptData1.xml, conoptData2.xml, etc.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"The list of file names like conoptData1.xml, conoptData2.xml, etc."
}

Nested Schema : nonDBEntities

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : reasonCodeList

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : remarks

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top