Jump to

• Request
• Response

Retrieve diagnostic tree node data

post

/custom-actions/diagnosticTreeNode

Returns the diagnostic tree node details for given matching criteria.

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

• depth: string
  The tree depth to traverse. If not provided, the complete depth is returned provided the response size is within configured size.
• diagnosticLogFileId(required): string
  The diagnostic log file identifier.
• filterMap: object filterMap
  Additional Properties Allowed: additionalProperties

  Dynamic filter key-value pairs. The keys may vary depending on use case. These are used as matching criteria. Only node details that satisfy these matching criterias are returned.
• nodeIds: array nodeIds
  The list of node IDs to traverse from. This is the parent node from where the logic will traverse down. If nodeIds are not used, the root (bulk plan process node) is used as the parent.

{
    "type":"object",
    "properties":{
        "diagnosticLogFileId":{
            "type":"string",
            "description":"The diagnostic log file identifier."
        },
        "depth":{
            "type":"string",
            "description":"The tree depth to traverse. If not provided, the complete depth is returned provided the response size is within configured size."
        },
        "nodeIds":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"The list of node IDs to traverse from. This is the parent node from where the logic will traverse down. If nodeIds are not used, the root (bulk plan process node) is used as the parent."
        },
        "filterMap":{
            "type":"object",
            "description":"Dynamic filter key-value pairs. The keys may vary depending on use case. These are used as matching criteria. Only node details that satisfy these matching criterias are returned.",
            "additionalProperties":{
                "oneOf":[
                    {
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    {
                        "type":"string"
                    }
                ]
            },
            "example":{
                "status":[
                    "FAILURE",
                    "SUCCESS"
                ],
                "processName":"Bulk Plan",
                "ORDER_RELEASE":[
                    "DOMAIN.ORDER_RELEASE_GID"
                ],
                "ITINERARY":[
                    "DOMAIN.ITINERARY_GID"
                ]
            }
        }
    },
    "required":[
        "diagnosticLogFileId"
    ]
}

Nested Schema : filterMap

Type: object

Additional Properties Allowed

Show Source

• additionalProperties

{
    "type":"object",
    "description":"Dynamic filter key-value pairs. The keys may vary depending on use case. These are used as matching criteria. Only node details that satisfy these matching criterias are returned.",
    "additionalProperties":{
        "oneOf":[
            {
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            {
                "type":"string"
            }
        ]
    },
    "example":{
        "status":[
            "FAILURE",
            "SUCCESS"
        ],
        "processName":"Bulk Plan",
        "ORDER_RELEASE":[
            "DOMAIN.ORDER_RELEASE_GID"
        ],
        "ITINERARY":[
            "DOMAIN.ITINERARY_GID"
        ]
    }
}

Dynamic filter key-value pairs. The keys may vary depending on use case. These are used as matching criteria. Only node details that satisfy these matching criterias are returned.

Example:

{
    "status":[
        "FAILURE",
        "SUCCESS"
    ],
    "processName":"Bulk Plan",
    "ORDER_RELEASE":[
        "DOMAIN.ORDER_RELEASE_GID"
    ],
    "ITINERARY":[
        "DOMAIN.ITINERARY_GID"
    ]
}

Nested Schema : nodeIds

Type: array

The list of node IDs to traverse from. This is the parent node from where the logic will traverse down. If nodeIds are not used, the root (bulk plan process node) is used as the parent.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"The list of node IDs to traverse from. This is the parent node from where the logic will traverse down. If nodeIds are not used, the root (bulk plan process node) is used as the parent."
}

Nested Schema : additionalProperties

Match One Schema

Show Source

• array type
• string

{
    "oneOf":[
        {
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        {
            "type":"string"
        }
    ]
}

Nested Schema : type

Type: array

Show Source

• Array of: string

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

The successful response.

Body ()

Root Schema : DiagnosticTreeNodeResponse

Type: object

Show Source

• actualDepth(required): integer
  The total depth of the given diagnostic tree data.
• completeTree(required): boolean
• reason: string
  Specifies the reason in case the status is FAILURE.
• requestedDepth(required): integer
  The requested depth of the tree. Represents the depth parameter in the rest request.
• returnedDepth(required): integer
  The returned depth of the tree.
• status(required): string
  The status of the process. The value can either be 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":"Specifies the reason in case the status is FAILURE."
        },
        "requestedDepth":{
            "type":"integer",
            "description":"The requested depth of the tree. Represents the depth parameter in the rest request."
        },
        "returnedDepth":{
            "type":"integer",
            "description":"The returned depth of the tree."
        },
        "status":{
            "type":"string",
            "description":"The status of the process. The value can either be SUCCESS or FAILURE."
        },
        "tree":{
            "$ref":"#/components/schemas/TreeNode"
        }
    },
    "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"
    }
}

400 Response

The default response.

Body ()

Root Schema : errorResponse400

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

404 Response

The default response.

Body ()

Root Schema : errorResponse404

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  The HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"The HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

Back to Top