Visualizations and Exports

retrieve the list of visualizations or exports for an asset group request get https //ryze formedix com/fws/api/transform/containeraid/version/list/transformtype/assetgroupaid where transformtype is specified as either visualization or export transformtype must be uppercase retrieve a list of the visualizations or exports available for the specified containeraid , version and assetgroupaid this request returns a list similar to the modal dialog displayed in ryze when selecting the visualize icon the response lists enabled plugins and the visualizations available for each plugin example response (export) json \[ { "plugin" "dataset designer core", "version" "2 9 0", "transforms" \[ { "transformid" "22c015e0 2ef9 44eb afda 7c7a0ae04b2a", "name" "define html preview", "description" "generate define html" }, { "transformid" "9443f6b3 bfa8 4864 a750 1eda591b2f6b", "name" "metadata specification", "description" "visualization of the asset group specification" }, { "transformid" "a836e1b4 fbe7 4e05 bb61 eb89b49d8a4c", "name" "define xml validation report", "description" "validation report generated in the form of an excel spreadsheet " }, ] }, ] errors http status error code 400 invalid container aid an invalid administeredid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version 400 invalid assetgroup aid an invalid administeredid was specified as the assetgroupaid 400 unknown transform type the requested type of transform was not recognised, e g it was not visualization 400 invalid assetgroup type the type of the specified asset group does not support visualizations e g generic dataset 404 unknown assetgroup unknown assetgroupaid within the containeraid / version pair 404 unknown container unknown containeraid / version pair see also docid\ tqpncp50s5muu3bfnmk9w retrieve the list of visualizations for an asset request get https //ryze formedix com/fws/api/transform/containeraid/version/list/visualization/assetgroupaid/assetaid retrieve a list of the visualizations available for the specified containeraid , version , assetgroupaid and asset aid this request returns a list similar to the modal dialog displayed in ryze when you select the visualize icon the response lists enabled plugins and the visualizations available for each plugin you can use the returned transformid to request the download of a visualization example response \[ { "plugin" "data acquisition designer core", "version" "2 2 0", "transforms" \[ { "transformid" "6e488d14 6015 469a acc5 1ddc0e4ce2a2", "name" "form preview", "description" "generate previews of the selectected forms in a study" }, { "transformid" "0e55aace e033 4aa6 87e9 429203beb9ec", "name" "metadata specification", "description" "visualization of the selected form" } ] } ] errors http status error code 400 invalid container aid an invalid administeredid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version 400 invalid assetgroup aid an invalid administeredid was specified as the assetgroupaid 400 invalid asset aid an invalid administeredid was specified as the assetaid 400 unknown transform type the requested type of transform was not recognised, i e it was not visualization 400 invalid assetgroup type the type of the specified asset group does not support visualizations e g generic dataset 404 unknown asset unknown assetaid within the containeraid / version pair and asset group 404 unknown assetgroup unknown assetgroupaid within the containeraid / version pair 404 unknown container unknown containeraid / version pair see also docid\ tqpncp50s5muu3bfnmk9w request to download a visualization or export for an asset group asynchronously request get https //ryze formedix com/fws/api/transform/containeraid/version/retrieveasync/assetgroupaid/transformid request that the visualization or export file for the asset specified ( containeraid , version , assetgroupaid and transformid )to be made available to download a unique identifier (uuid) for the prepared download is returned use this uuid in the file retrieval call as fileuuid , see docid\ jz8woysbi e4g4opghdyk the file uuid is generated before the file is ready, requests for the file return a 404 response until the background execution is complete addtionally, further requests for the same visualization return a 409 response with the message “already queued” until the execution is completed example response { "uuid" "01234567 89ab cdef 0123 456789abcdef" } http status error code 400 invalid container aid an invalid administeredid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version 400 invalid assetgroup aid an invalid administeredid was specified as the assetgroupaid 400 invalid uuid an invalid uuid was specified as the transformid 400 invalid assetgroup type asset groups of this type cannot have an odm generated 404 unknown container unknown containeraid / version pair 404 unknown assetgroup could not find specified assetgroupaid for given containeraid / version pair 404 unknown transform could not find the specified transformid 409 already queued the visualization is still in progress and cannot be queued again until it is completed request to download a visualization or export for an asset group (deprecated) request get https //ryze formedix com/fws/api/transform/containeraid/version/retrieve/assetgroupaid/transformid to prevent time out issues, it is recommended that you use the asynchronous request above request for the visualization or export output file for the asset specified by containeraid , version , assetgroupaid and transformid to be made available to download the transformid can be found from the retrieve the list of visualizations or exports for an asset group request a unique identifier for the prepared download is returned once the execution is complete , which can then be used to request download of the file the returned uuid should be used in the file retrieval call as the fileuuid example response { "uuid" "01234567 89ab cdef 0123 456789abcdef" } see also, https //docs formedix com/api/general#w vmw errors http status error code 400 invalid container aid an invalid administeredid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version 400 invalid assetgroup aid an invalid administeredid was specified as the assetgroupaid 400 invalid uuid an invalid uuid was specified as the transformid 400 invalid assetgroup type asset groups of this type cannot have an odm generated 404 unknown container unknown containeraid / version pair 404 unknown assetgroup could not find specified assetgroupaid for given containeraid / version pair 404 unknown transform could not find the specified transformid see also docid\ tqpncp50s5muu3bfnmk9w request to download a visualization for an asset request get https //ryze formedix com/fws/api/transform/containeraid/version/retrieve/assetgroupaid/assetaid/transformid request for the visualization output file for the asset specified by containeraid , version , assetgroupaid transformid to be made available to download a unique identifier is returned for the download, which can then be used to request download of the file the returned uuid should be used in the file retrieval call as the fileuuid example response { "uuid" "01234567 89ab cdef 0123 456789abcdef" } see also, https //docs formedix com/api/general#w vmw errors http status error code 400 invalid container aid an invalid administeredid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version 400 invalid assetgroup aid an invalid administeredid was specified as the assetgroupaid 400 invalid asset aid an invalid administeredid was specified as the assetaid 400 invalid uuid an invalid uuid was specified as the transformid 400 invalid assetgroup type asset groups of this type cannot have an odm generated 404 unknown container unknown containeraid / version pair 404 unknown assetgroup could not find specified assetgroupaid for given containeraid / version pair 404 unknown asset unknown asset within the containeraid / version pair and asset group see also docid\ tqpncp50s5muu3bfnmk9w