Visualizations and Exports
Retrieve the list of Visualizations or Exports for an Asset Group
GET {baseUrl}/fws/api/transform/containerAID/version/list/transformType/assetgroupAIDWhere 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):
[
{
"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 Common Errors
Retrieve the list of Visualizations for an Asset
GET {baseUrl}/fws/api/transform/containerAID/version/list/visualization/assetgroupAID/assetAIDRetrieve 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 Common Errors
Request to download a Visualization or Export for an Asset Group Asynchronously
GET {baseUrl}/fws/api/transform/containerAID/version/retrieveAsync/assetgroupAID/transformIDRequest 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 Retrieve a previously prepared File.
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:
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)
GET {baseUrl}/fws/api/transform/containerAID/version/retrieve/assetgroupAID/transformIDTo 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, Retrieve a previously prepared file.
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 Common Errors
Request to download a Visualization for an Asset
GET {baseUrl}/fws/api/transform/containerAID/version/retrieve/assetgroupAID/assetAID/transformIDRequest 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, Retrieve a previously prepared file.
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 Common Errors
