Skip to main content

Overview

Creates a report relating to a state machine associated with a token.

HTTP request

POST /Agent/StateMachines/CreateReport

Authentication

Requires a valid JWT bearer token.

Request (JSON)

{
	"tokenId":Required(Str(PTokenId)),
	"reportType":Required(Str(PReportType)),
	"reportFormat":Required(Str(PReportFormat))
}

Input parameters

ParameterDescription
PTokenIdID of token associated with state machine.
PReportTypeType of report to generate. Possible values include Present, History, StateDiagram and Profiling.
PReportFormatFormat of report to generate. Possible values include Markdown, Html, Text, Xaml, XamarinXaml and SmartContract.

Response (JSON)

{
	"report":Required(Str(PReport))
}

Response parameters

ParameterDescription
PReportGenerated report.

Notes

This endpoint uses the request schema notation described in Pattern matching.