Files

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.

Root

The operations for the Root resource.

Get top-level resource links

Internal-Use OnlyReturns a list of links to the top-level resources that are available through the API. These top-level links include create and retrieve operations for /files./

Check the state of the service

Internal-Use OnlyIndicates whether the service is available./

Files

The CRUD (Create, Read, Update, Delete) operations for files.

Get file resources

Internal-Use OnlyRetrieves file resources for the specified criteria. Standard paging, filtering, and sorting options are available./files

Delete file resources

Internal-Use OnlyDeletes file resources for the specified parentUri. If the user is not authorized to delete all matching files, no files are deleted./files

Get schema for indexing

Internal-Use OnlyThis endpoint returns schema field to be indexed by search service./files

Create new file resource

Internal-Use OnlyCreates a new file resource by passing file content in the request body./files

Create a new file resource

Internal-Use OnlyCreates a new file resource by passing a file in the form of a multipart request./files

Get file resources for multiple parentUris

Internal-Use OnlyRetrieves the file resources that are associated with multiple parentUri specifications. Request the parentUri values in the body. The returned collection is grouped by parentUri./files

Check if a file resource exists

Internal-Use OnlyDetermines whether a file resource exists for the specified fileId./files/{fileId}

Get a file resource

Internal-Use OnlyRetrieves a file resource by specifying a fileId./files/{fileId}

Update a file resource

Internal-Use OnlyUpdates the file resource information. The user can change these attributes: name, description, parentUri, documentType, contentDisposition, properties,expirationTimeStamp,typeDefName and searchable/files/{fileId}

Update a file resource

Internal-Use OnlyUpdates the file resource information. The user can change these attributes: name, description, parentUri, documentType, contentDisposition, properties, expirationTimeStamp,typeDefName and searchable/files/{fileId}

Delete a file resource

Internal-Use OnlyDeletes the file resource./files/{fileId}

Get file resource content

Internal-Use OnlyRetrieves the content of the file resource./files/{fileId}/content

Update file resource content

Internal-Use OnlyUpdates the content of the file resource./files/{fileId}/content

Copy an existing file

Internal-Use OnlyCopies the file if the user has Read access to the specified file./files/{fileId}/copy

Check if a file resource exists for given fileVersion

Internal-Use OnlyDetermines whether a file resource exists for the specified version of fileId./files/{fileId}/version/{fileVersion}

Get a file resource for specific version

Internal-Use OnlyRetrieves a file resource by specifying fileVersion of a fileId./files/{fileId}/version/{fileVersion}

Get the file resource content for a specified version

Internal-Use OnlyRetrieves the content of the file resource for a specified version./files/{fileId}/version/{fileVersion}/content

Get all the versions of a given file id

Internal-Use OnlyRetrieves file resources of all the versions of a given fileId. Standard paging, option is available./files/{fileId}/versions

Index

The operations to obtain a generic indexable representation of files.

Get indexable representations for parentUris

Internal-Use OnlyRetrieves indexable representations of files that are associated with multiple parentUri specifications. Request the parentUri values in the body. The returned collection is grouped by parentUri./files

Get indexable representations for files

Internal-Use OnlyRetrieves indexable representations of file resources for the specified criteria. Standard paging is available./files

Get a generic indexable representation

Internal-Use OnlyRetrieves a generic indexable representation of file for the specified identifier./files/{fileId}

Summary

The operations to obtain a generic summary representation of files.

Get summary representations

Internal-Use OnlyRetrieves summary representations of file resources for the specified criteria. Standard paging, filtering, and sorting options are available./files

Get a generic summary representation

Internal-Use OnlyRetrieves a generic summary representation of a file for the specified identifier./files/{fileId}

Security

The operations to unquarantine the file.

Update the quarantine status of file resource

Internal-Use OnlyUpdates the quarantine file resource information. The user can change only quarantine status. This end-Point is only accessible to SAS Administrators./files/{fileId}/quarantine

Settings

The operations to return configuration settings information.

Get the API/service configuration settings

Internal-Use OnlyReturns the possible configuration settings that this API/service shares./commons/settings