High level tasks for authorization, files and folders, and projects

platform_administration

2023.03

2023.10

2024.03

2024.06

2024.07

2024.08

2024.09

The Files API provides persistence of files, such as comment attachments and report images.With this version File API will now support versioned files. A solution can maintain multiple versions of a file. There are few additional parameters which will be required while creation of File, which indicates that the File is a versioned file.

Files

2022.09

Viya_35

The Files API provides persistence of files, such as comment attachments and report images.

Retrieves the content of the file resource.

A conditional range request. The client must specify the previously returned `ETag` as the `If-Range` header value. This determines whether the resource has been modified. If it has been modified, the entire file is returned. Otherwise, only partial content is returned using the `Range` header. 

If-Range

A specific range request. The value specifies the required byte range--for example, bytes=0-100.

Range

If true, administrator can download the quarantine file content for analysis

Access-Quarantine

The identifier of the file resource for which to fetch content.

fileId

Specifies whether to use the persisted content-disposition value. If this is specified to true and the word "attachment" appears in the content-disposition, it is changed to "inline". No other changes are made to the content-disposition value.

changeContentDisposition

The request succeeded. The stream is returned in the response body.

The partial content request succeeded. The requested range of data is in the response body.

error response when non admin is trying to access the content of quarantined file.

Non privilaged user trying to access quarantine file content, will get HTTP Forbidden error

error response when specifed file is not present in the system.

No content was found for the specified identifier.

An invalid or non-overlapping range was specified in the `Range` request header.

Get file resource content

File

File to Patch

File Resource Collection

File Resource

File Resource Indexable Collection

Collection of indexable representation of the files.

File Resource Indexable Data

Indexable Data Element

File Resource Summary Collection

A generic summary representation of a file.

File Resource Summary

The list of links to top-level resources and operations available from the root of the API.

error2

Multiple parentUri values that are specified as an array of string values.

selection

This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

Name	Type	Required	Description
Access-Quarantine	boolean	false	If true, administrator can download the quarantine file content for analysis
If-Range	string	false	A conditional range request. The client must specify the previously returned `ETag` as the `If-Range` header value. This determines whether the resource has been modified. If it has been modified, the entire file is returned. Otherwise, only partial content is returned using the `Range` header.
Range	string	false	A specific range request. The value specifies the required byte range--for example, bytes=0-100.

Status	Meaning	Description
200	OK	The request succeeded. The stream is returned in the response body.
206	Partial Content	The partial content request succeeded. The requested range of data is in the response body.
403	Forbidden	Non privilaged user trying to access quarantine file content, will get HTTP Forbidden error	Schema
404	Not Found	No content was found for the specified identifier.	Schema
416	Requested Range Not Satisfiable	An invalid or non-overlapping range was specified in the `Range` request header.

Get file resource content

Request Samples

Response Samples

Path Parameters

Query Parameters

Header Parameters

Responses