Transaction Summary Status

Draft

Retrieves the status of all active or completed AI summary jobs for a specified transaction.
This endpoint helps in tracking the progress and completion status of AI-generated transaction summaries.
Note: This service depends on the Imaging AI Service. Ensure the Imaging services are operational before calling this endpoint.

URI

  • GET /rest/applications/{name}/transactions/summary/status

Path Parameters

  • name (string):
    This parameter identifies the analyzed application.
    The application name must be properly encoded if it is required. Character back-quote is not allowed.

Query Parameters

  • id (number):
    The unique identifier (aipId) of the transaction.
  • guid (string):
    The unique identifier (guid) of the transaction summary job (response from generate transaction summary api).

Responses

  • application/json:

    Returns a list of job objects containing the status and metadata for each AI summary job related to the specified transaction.

    Example:

    {
        "success": [
            {
                "id": "WebGoat-test-42408cdc-71dc-41cf-b492-f03694479fe2",
                "status": "Done",
                "domain": "neo4j",
                "type": "Genarating AI Summary",
                "logsFile": "C:\\Program Files\\Cast\\Imaging\\Cast-Imaging-Viewer/logs\\WebGoat-test-42408cdc-71dc-41cf-b492-f03694479fe2.log",
                "transactionId": "56548"
            },
            {
                "id": "WebGoat-test-45fb1ed2-dee5-4743-ac36-a662eaf2223e",
                "status": "Done",
                "domain": "neo4j",
                "type": "Genarating AI Summary",
                "logsFile": "C:\\Program Files\\Cast\\Imaging\\Cast-Imaging-Viewer/logs\\WebGoat-test-45fb1ed2-dee5-4743-ac36-a662eaf2223e.log",
                "transactionId": "56548"
            }
        ]
    }
    

    JSON Representation

    Property Type Description
    id string Unique guid for the AI transaction summary job
    status string Current status of the job (e.g., Running, Done, Failed)
    domain string Tenant in which the application exists in
    type string Type of job eg. Genarating AI Summary
    logsFile string Path to the log file containing job execution details
    transactionId string The ID of the transaction the job is associated with