Visual Analytics

The Visual Analytics API provides simplified ways to perform basic tasks with reports. Tasks include exporting a report as a PDF file, or as a package file, or exporting an image of a part of the report.

Root

Contains the operations for the root resource.

get

Get a list of top-level links

Internal-Use OnlyReturns a list of link objects for some of the primary resources surfaced by this API. The list includes basic actions that are identified by their relation properties, such as printing a report, exporting a report package, exporting the data in a report, and so on See the example response for the list of expected links with their relation names, types and URIs./

Export

Contains the operations for immediate export of content.

get

Jobs

Contains the operations used by clients for asynchronous execution.

post

Create and run an action to export a report as a package file

Internal-Use OnlyStarts a job from the request information that creates and exports the report as a package file. This starts the process of creating a package, but returns quickly. If the result is not ready by the time of the response, the client must poll until completion and then download the ZIP file. By default, only the user who created the package is authorized to retrieve it. For packages saved to a folder, the authorizations are controlled by the folder. Note that the /SASVisualAnalyticsCommon_capabilities/exportPackage capability is enforced on this operation. There is no support for creating a package with a back-level version; that is, the created package has the service's current version of package file./reports/{reportId}/exportPackage

post

Create and run an action to export a report as a PDF file

Internal-Use OnlyStarts a job from the request information that creates and exports the report as a PDF file. Apply the rendering option values in the request object to the creation of the PDF output. The request's options override (1) any defaults of the underlying rendering services, and (2) any defaults that were saved with the report by the SAS Visual Analytics application./reports/{reportId}/exportPdf

post

Create and run an action to export an image file

Internal-Use OnlyStarts a job from the request information that creates and exports the image as an SVG file or a PNG file./reports/{reportId}/exportImage

post

Create and run an action to export a data file

Internal-Use OnlyStarts a job from the request information to export the data for a report object as a datafile. The format of the file is specified by an option as comma-separated values, tab-separated values, or a spreadsheet in Excel format./reports/{reportId}/exportData

get

Get the job with its status and link to results

Internal-Use OnlyGets the job with its status and links to results. This operation is specific to the case of asynchronous execution of a report action job. If the job has completed and is successful, the response object has links to individual results./jobs/{jobId}

delete

Delete the job with its status and link to results

Internal-Use OnlyDeletes the job information. This operation is specific to the case of asynchronous execution of a report action job. If the job is still running, attempt to cancel it. This does not attempt to delete result files that reside under control of other services./jobs/{jobId}

Report

Contains the operations used by clients for manipulating a report.

post

Create a report while applying the specified operation(s)

Internal-Use OnlyCreates a report while applying the specified operation(s). The new report can be generated with a specific name and location by denoting the resultFolder and resultReportName in the body of the request. If neither of these are specified in the body, then a report named "Report" is generated in the location /folders/folders/@myFolder./reports

put

Update a report while applying the specified operation(s)

Internal-Use OnlyCreates or updates a report while applying the specified operation(s). The source report for the updates is denoted in the uri of the request. A new report can be generated by denoting a resultFolder or resultReportName in the body of the request. If neither of these are specified in the body, the source report is directly updated./reports/{reportId}

delete

Delete a report

Internal-Use OnlyDeletes the specified report and its content. Removes the report from the parent folder./reports/{reportId}

put

Create a copy of a report

Internal-Use OnlyCreates a copy of a report. The report to be copied is denoted in the uri of the request. The name and location of the copied report can be specified in the body of the request with the resultFolder and resultReportName properties. These are optional properties. If not specified, the copy is placed in the same folder as the original report, using the same report name along with an appended version./reports/{reportId}/copy

Visual Analytics

Root

Get a list of top-level links

Export

Export a PDF of a report

Export an SVG image of report or report object

Export a PNG image of a report or report object

Export a report package

Export data for one object in a report as comma-separated values

Export data for one object in a report as tab-separated values

Export data for one object in a report as an XLSX file

Jobs

Create and run an action to export a report as a package file

Create and run an action to export a report as a PDF file

Create and run an action to export an image file

Create and run an action to export a data file

Get the job with its status and link to results

Delete the job with its status and link to results

Report

Create a report while applying the specified operation(s)

Update a report while applying the specified operation(s)

Delete a report

Create a copy of a report