RestApiCategories.platformAdministration.desc

platform_administration

2024.09

2026.04

2025.09

2026.05

2025.03

2026.06

2026.07

2026.03

The File Service API is a versatile solution for storing, retrieving, and managing different types of files such as documents, attachments, and reports. Each file requires a specified name and  content type and can optionally be linked to a parentUri, which associates the file with another identifiable object. This feature allows users to organize and retrieve files either individually by their  unique file ID or in groups based on the associated parentUri. Each file includes a content stream to ensure that the file’s data is preserved and accessible. Once a file is created, users can update its  metadata or replace the file content entirely. The API also supports file versioning, enabling multiple versions of the same file to be maintained over time by including version-specific parameters during  creation. Deletion options are provided as well, allowing users to delete individual files by ID or remove all files associated with a specific parentUri. Overall, the File Service API offers a comprehensive and adaptable platform for persistent file management across various application use cases.


Files

Viya_35

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

Determines whether the files collection endpoint is available.

The request succeeded. The files collection endpoint is available.

Content-Type

Check if file resources endpoint is available

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

The configuration settings for this service.

Attributes Map

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)

baseCollection2

error2

field

File

File Resource

File Resource Collection

File Resource Indexable Collection

Collection of indexable representation of the files.

File Resource Indexable Data

A generic summary representation of a file.

File Resource Summary

File Resource Summary Collection

The configuration settings exposed for commons usage.

File Service Configuration Settings

File to Patch

Indexable Data Element

A link to a related operation or resource.

link

Catalog metadata archive for a file resource.

Metadata Archive

Quarantine file to Patch

The schema representation of file service fields to be indexed.

schema

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

selection

Transfer object representation used for export and import operations.

Transfer Object

Connector details that describe transfer relationships to related resources.

Check if file resources endpoint is available

Request Samples

Responses