Transaction Summary

Draft

Retrieves the generated AI summary for a specific transaction.
The response includes the summary content as well as token usage information.

URI

  • GET /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:

    Returns the transaction summary along with the tokens consumed

    Example:

    {
            "title": "summary title",
            "name": "transaction-name",
            "summary": "AI-Summary...",
            "input_tokens": 815,
            "output_tokens": 586
    }
    

    JSON Representation

    Property Type Description
    title string Title of the summary
    name string Name of the transaction
    summary string AI-generated functional and technical explanation of the transaction
    input_tokens integer Number of input tokens used for generating the summary
    output_tokens integer Number of output tokens generated in the summary