Table of Contents
/Tokens/GetDescription
Creates a report relating to a state machine associated with a token.
JSON
- Request
{ "tokenId":Required(Str(PTokenId)), "reportFormat":Required(Str(PReportFormat)) }- Response (if successful)
{ "report":Required(Str(PReport)) }
XML
- Request
<GetDescription xmlns="https://waher.se/Schema/BrokerAgent.xsd" tokenId=(Required(Str(PTokenId))) reportFormat=(Required(Str(PReportFormat))) />- Response (if successful)
<ReportResult xmlns="https://waher.se/Schema/BrokerAgent.xsd" report=(Required(Str(PReport))) />
Input Parameters
| Parameter | Description |
|---|---|
PTokenId |
ID of token. |
PReportFormat |
Format of report to generate. Possible values include Markdown, Html, Text, Xaml, XamarinXaml and SmartContract. |
Response Parameters
| Parameter | Description |
|---|---|
PReport |
Generated report. |
Javascript Library
Use the following asynchronous method in the Javascript Library, to call this resource.
var Response = await AgentAPI.Tokens.GetDescription(TokenId,Format);