Jump to

• Request
• Response

Retrieve diagnostic tree data statistics

post

/custom-actions/diagnosticTreeStats

diagnosticTreeStats returns statistics and filterable objects for a diagnostic log file.

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
  Unique identifier for the diagnostic log file.

{
    "required":[
        "diagnosticLogFileId"
    ],
    "properties":{
        "diagnosticLogFileId":{
            "type":"string",
            "description":"Unique identifier for the diagnostic log file."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The successful response.

Body ()

Root Schema : DiagnosticTreeStatsResponse

Type: object

Show Source

• DiagnosticFailureSummaryList: array DiagnosticFailureSummaryList
• diagnosticLogSummary: diagnosticLogSummary
• filterObjects: object filterObjects
  Additional Properties Allowed: additionalProperties

  A map of dynamic, filterable OTM/GTM objects to their list of values. For example, OTM object of EQUIPMENT_GROUP and list values including 42FT DRY VAN and 28FT DRY VAN.
• root: object DiagnosticRootNodeEntry

{
    "properties":{
        "DiagnosticFailureSummaryList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DiagnosticFailureSummary"
            }
        },
        "diagnosticLogSummary":{
            "properties":{
                "failedOrderPKs":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    },
                    "description":"List of failed order release IDs."
                },
                "failureSummary":{
                    "type":"string",
                    "nullable":true
                },
                "successfulOrderPKs":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    },
                    "description":"List of successfully planned order release IDs"
                }
            }
        },
        "filterObjects":{
            "type":"object",
            "description":"A map of dynamic, filterable OTM/GTM objects to their list of values. For example, OTM object of EQUIPMENT_GROUP and list values including 42FT DRY VAN and 28FT DRY VAN.",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "example":{
                "EQUIPMENT_GROUP":[
                    "42FT DRY VAN",
                    "28FT DRY VAN"
                ],
                "RULE_SET":[
                    "roset1"
                ],
                "ITINERARY":[
                    "USA_TO_USA"
                ]
            }
        },
        "root":{
            "type":"object",
            "$ref":"#/components/schemas/DiagnosticRootNodeEntry"
        }
    }
}

Nested Schema : DiagnosticFailureSummaryList

Type: array

Show Source

• Array of: object DiagnosticFailureSummary

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DiagnosticFailureSummary"
    }
}

Nested Schema : diagnosticLogSummary

Type: object

Show Source

• failedOrderPKs: array failedOrderPKs
  List of failed order release IDs.
• failureSummary: string
• successfulOrderPKs: array successfulOrderPKs
  List of successfully planned order release IDs

{
    "properties":{
        "failedOrderPKs":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"List of failed order release IDs."
        },
        "failureSummary":{
            "type":"string",
            "nullable":true
        },
        "successfulOrderPKs":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"List of successfully planned order release IDs"
        }
    }
}

Nested Schema : filterObjects

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "description":"A map of dynamic, filterable OTM/GTM objects to their list of values. For example, OTM object of EQUIPMENT_GROUP and list values including 42FT DRY VAN and 28FT DRY VAN.",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    },
    "example":{
        "EQUIPMENT_GROUP":[
            "42FT DRY VAN",
            "28FT DRY VAN"
        ],
        "RULE_SET":[
            "roset1"
        ],
        "ITINERARY":[
            "USA_TO_USA"
        ]
    }
}

A map of dynamic, filterable OTM/GTM objects to their list of values. For example, OTM object of EQUIPMENT_GROUP and list values including 42FT DRY VAN and 28FT DRY VAN.

Example:

{
    "EQUIPMENT_GROUP":[
        "42FT DRY VAN",
        "28FT DRY VAN"
    ],
    "RULE_SET":[
        "roset1"
    ],
    "ITINERARY":[
        "USA_TO_USA"
    ]
}

Nested Schema : DiagnosticRootNodeEntry

Type: object

Show Source

• rootEntry: object DiagnosticNodeEntry
• rootId: string
  The node ID of the root diagnostic tree node.

{
    "type":"object",
    "properties":{
        "rootId":{
            "type":"string",
            "description":"The node ID of the root diagnostic tree node."
        },
        "rootEntry":{
            "$ref":"#/components/schemas/DiagnosticNodeEntry"
        }
    }
}

Nested Schema : DiagnosticFailureSummary

Type: object

Show Source

• entities: object entities
  Additional Properties Allowed: additionalProperties

  Key-value map of entities like itinerary, locations, and orders.
• keyEntryNode: object DiagnosticRootNodeEntry
• processID: array processID
  List of Process IDs asssociated with the diganostic failure.
• processNodeIDChain: string
  A string representation of the process node ID chain.
• summary: array summary
  A summary of the diagnostic failure, if any.
• tips: array tips
  Describes the common reason for the diagnostic failure, if any.

{
    "type":"object",
    "properties":{
        "keyEntryNode":{
            "$ref":"#/components/schemas/DiagnosticRootNodeEntry"
        },
        "entities":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "description":"Key-value map of entities like itinerary, locations, and orders."
        },
        "processID":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"List of Process IDs asssociated with the diganostic failure."
        },
        "processNodeIDChain":{
            "type":"string",
            "description":"A string representation of the process node ID chain."
        },
        "summary":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"A summary of the diagnostic failure, if any."
        },
        "tips":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Describes the common reason for the diagnostic failure, if any."
        }
    }
}

Nested Schema : entities

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    },
    "description":"Key-value map of entities like itinerary, locations, and orders."
}

Key-value map of entities like itinerary, locations, and orders.

Nested Schema : processID

Type: array

List of Process IDs asssociated with the diganostic failure.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"List of Process IDs asssociated with the diganostic failure."
}

Nested Schema : summary

Type: array

A summary of the diagnostic failure, if any.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"A summary of the diagnostic failure, if any."
}

Nested Schema : tips

Type: array

Describes the common reason for the diagnostic failure, if any.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Describes the common reason for the diagnostic failure, if any."
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

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

Nested Schema : failedOrderPKs

Type: array

List of failed order release IDs.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"List of failed order release IDs."
}

Nested Schema : successfulOrderPKs

Type: array

List of successfully planned order release IDs

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"List of successfully planned order release IDs"
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

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

Nested Schema : DiagnosticNodeEntry

Type: object

Show Source

• childIds: array childIds
  The list of child node IDs.
• children: array children
  The list of child nodes.
• depth: integer
• diagFileSize: integer
  The size of the diagnostic file in bytes.
• endTime: string
  The end time of the process.
• exportFileEntityMap: object exportFileEntityMap
  Additional Properties Allowed: additionalProperties

  The map of export entity types to file names list.
• failureReasonList: array failureReasonList
• filterStatus: boolean
• hasChilds: boolean
• id: string
  The node ID of the diagnostic tree node.
• parentId: string
  The parent node ID of the current node.
• processName: string
  The name of the current process that the node represents.
• processNameId: string
  The ID of the current process that the node represents.
• reasonCodeList: array reasonCodeList
• remarksList: array remarksList
• startTime: string
  The start time of the process.
• statusList: array statusList

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The node ID of the diagnostic tree node."
        },
        "parentId":{
            "type":"string",
            "description":"The parent node ID of the current node."
        },
        "startTime":{
            "type":"string",
            "description":"The start time of the process."
        },
        "processName":{
            "type":"string",
            "description":"The name of the current process that the node represents."
        },
        "processNameId":{
            "type":"string",
            "description":"The ID of the current process that the node represents."
        },
        "exportFileEntityMap":{
            "type":"object",
            "description":"The map of export entity types to file names list.",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "example":{
                "EXPORT_FILE":[
                    "conoptdata1.xml"
                ]
            }
        },
        "endTime":{
            "type":"string",
            "description":"The end time of the process."
        },
        "statusList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "remarksList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "reasonCodeList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "childIds":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"The list of child node IDs."
        },
        "diagFileSize":{
            "type":"integer",
            "description":"The size of the diagnostic file in bytes."
        },
        "hasChilds":{
            "type":"boolean"
        },
        "filterStatus":{
            "type":"boolean"
        },
        "depth":{
            "type":"integer"
        },
        "failureReasonList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "children":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DiagnosticNodeEntry"
            },
            "description":"The list of child nodes."
        }
    }
}

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 list of child nodes.

Show Source

• Array of: object DiagnosticNodeEntry

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DiagnosticNodeEntry"
    },
    "description":"The list of child nodes."
}

Nested Schema : exportFileEntityMap

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "description":"The map of export entity types to file names list.",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    },
    "example":{
        "EXPORT_FILE":[
            "conoptdata1.xml"
        ]
    }
}

The map of export entity types to file names list.

Example:

{
    "EXPORT_FILE":[
        "conoptdata1.xml"
    ]
}

Nested Schema : failureReasonList

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 : remarksList

Type: array

Show Source

• Array of: string

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

Nested Schema : statusList

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