Generate Transaction Summary

Draft

Initiates AI-based summary generation for a specified transaction.
This service returns a jobId (GUID) for tracking the background summary generation task.
Summary generation is asynchronous and may take time. This API only returns the job ID and does not wait for summary completion.
Note: This service relies on several Imaging components. Please make sure all imaging services are running before calling this api.

URI

  • POST /rest/applications/{name}/transactions/{id}/summary

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.
  • id (number):
    The unique identifier (aipId) of the transaction.

Responses

  • application/json:

    The response is the jobId for the summary job

    Example:

    {
    "success": "WebGoat-test-45fb1ed2-dee5-4743-ac36-a662eaf2223e"
}

    JSON Representation

    Property Type Description
    success string Unique guid for the AI transaction summary job