Skip to main content

Overview

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

HTTP request

POST /Agent/Tokens/GetDescription

Authentication

Requires a valid JWT bearer token.

Request (JSON)

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

Input parameters

ParameterDescription
PTokenIdID of token.
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.