RestApiCategories.platformAdministration.desc

platform_administration

2024.12

The Folders API provides an organizational structure for SAS and external content. It can also be used for favorites folders or a history of objects accessed. The resources that are stored in folders (members) use a URI to point back to those resources. <H4><strong>Terminology:</strong></H4> <H4>folder</H4>
  <p> A virtual container for other folders, or any resource that can be represented
with a URI.</p> <H4>member</H4>
  <p> A resource contained in a folder. A member can itself be a folder, creating
a hierarchical structure for folders and subfolders. Members have two types: child and reference. A child member inherits authorizations from its container, and a given resource can be a child only in a single folder. Reference members do not inherit authorizations, and a resource can have many references in many different folders.


Folders

2024.09

2024.08

2023.10

2024.10

2024.03

2024.11

2023.03

Viya_35

Find an object, if it exists, by path. The client provides an ordered list of parent folder names, the object name, and the object content type.

Path

The set of parent names, the object name, and the object content type.

A briefer version of the folder representation

The summarized representation of a resource. Often used in collection responses when more specific details are not needed.

Resource Summary

The object was found and returned as a summary object.

Example of an error response from the service

Error

The request was invalid. The request body was malformed or is absent.

No object with the specified type exists at the requested path.

Find an object by path

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)

baseCollection

A link to a related operation or resource.

Link

The response from a pre-flight validation request. For APIs that support validation, the client can run operations (typically on resources in the `/commons/validation`) with `application/vnd.sas.validation+json` as the requested response type (via the `Accept:` request header). The service validates the request but does not execute the request, and returns this response to indicate whether the request was valid at the time it was made.

Validation Response

Folder Schema

The full representation of a folder object.

Folder

The schema for creating a new folder member.

Member Schema

The full representation of a folder member.

Member

Folder Collection

Member Collection

An ancestor entry that is returned from an ancestor's request.

Ancestor Type

A collection of ancestor entries that are returned from an ancestors request.

Ancestor Collection

Folder Type

Folder Type Collection

A representation of a delegate identifier that is recognized by the Folders API.

Delegate

Delegate Collection

A collection of data sufficient to catalog a set of entities and relationships.

Name	Type	Required	Description
items	array [string]	false	An ordered list of parent folder names, with the desired object's name at the end of the list.
contentType	string	false	The content type of the object to return. Must match the content type of the Member entry.
typeDefName	string	false	The type definition name of the member being requested.
version	integer	false	This media type's schema version number. This representation is version 1.

Status	Meaning	Description
200	OK	The object was found and returned as a summary object.	Schema
400	Bad Request	The request was invalid. The request body was malformed or is absent.	Schema
404	Not Found	No object with the specified type exists at the requested path.	Schema

Find an object by path

Request Samples

Response Samples

Request Body

Responses