Simulator [CH - QA]
ReportAttributesType
objectBasic attributes of the object.
namestring
Name of the report
>= 1 characters<= 50 characters
Example:IM-Results
formatstring
Format of the document generated.
Allowed values:CSVJSONXML
Example:CSV
typestring
Type of the report generated
>= 1 characters<= 10 characters
Example:IM-Results
datestring(date)
Date of the report generation
Example:2020-01-01
Example
ReportType
objectData structure for all operations.
attributesobject
Basic attributes of the object.
Show Child Parameters
idstring(string)
UUID type implementing the RFC 4122.
Match pattern:^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$
Example:95b1b467-bd69-4436-8181-96c16408c230
typestringrequired
Type of the resource attributes being represented
Allowed values:simulationcalculationresultopen-positionimport-open-positionsresult-detailreport
Example:simulation
Example
ReportsJsonApiType
objectCollection in JSON:API format. Collection is paginated
linksobjectrequired
Show Child Parameters
dataarray[object]requiredread-only
Data structure for all operations.
Show Child Parameters
metaobjectrequired
Show Child Parameters
Example
BasicResourceType
objectidstring(string)
UUID type implementing the RFC 4122.
Match pattern:^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$
Example:95b1b467-bd69-4436-8181-96c16408c230
typestringrequired
Type of the resource attributes being represented
Allowed values:simulationcalculationresultopen-positionimport-open-positionsresult-detailreport
Example:simulation
Example