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

Returns a list of folder members. Standard paging, filtering, and sorting options are available. The media type of the returned collection items is application/vnd.sas.content.folder.member. Default sorting for this collection is name:ascending, unless the folder is of the history folder type. Default sorting for history folders is added:descending, which orders the elements starting with the most recently added.


If provided, this should be an alternative media type that the service recognizes. If the media type is not one that the service can provide, a 406 response is returned. Valid media types for the member collection are application/vnd.sas.content.folder.member+json (default), application/vnd.sas.content.folder.member.summary+json (an abbreviated format that provides fewer links, but better performance), and application/vnd.sas.summary+json (a standard summary representation).

Accept-Item

Enumerates the languages that the client prefers to use for the response. This can be used to provide localized data where available.

Accept-Language

The identifier of a specific folder, or of one of the delegate strings @myFolder, @appDataFolder, @myHistory, @myFavorites, or @public.

folderId

Offset of first member to return. The default value is 0.

start

Maximum number of members to return. The default value is 20.

limit

Filter criteria for returned members. See [Filtering in REST APIs](https://developer.sas.com/apis/rest/Topics/#filters). For example, you can filter for a member with a given name as a way to test if a folder already has a member with that name: <code>?filter=eq(name, 'bobsyouruncle')</code>

filter

Sort returned collection of members. See [Sorting in REST APIs](https://developer.sas.com/apis/rest/Topics/#sorting). The member collection can be sorted by folders first by using sortBy=eq(contentType,'folder'):descending Use :ascending to soft by folders last. Specifying sortBy=eq(contentType,'folder'):descending,name:ascending,type:ascending sorts by folders first, then by name, then by type.

sortBy

If true, the members of the requested folder, plus all of its descendants, are returned in a flat list (no order is guaranteed). Reference members that refer to folders are not followed unless the followReferences parameter is true. The default value of this parameter is false.

recursive

If true, references to other folders are followed when returning the recursive list of members. If recursive is false, then the value of this parameter is meaningless. The default value of this parameter is false.

followReferences

The request succeeded. A list of folder members was returned.

The content type of the response (application/vnd.sas.collection+json)

Content-Type

The request was invalid. An invalid filter or combination of request parameters was provided.

Get a list of folder members

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

Error

A link to a related operation or resource.

Link

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

Resource Summary

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.

Status	Meaning	Description
200	OK	The request succeeded. A list of folder members was returned.	Headers
400	Bad Request	The request was invalid. An invalid filter or combination of request parameters was provided.
404	Not Found	No folder exists at the requested path.

Get a list of folder members

Request Samples

Response Samples

Path Parameters

Query Parameters

Header Parameters

Responses

Name	Type	Required	Description
filter	string	false	Filter criteria for returned members. See Filtering in REST APIs. For example, you can filter for a member with a given name as a way to test if a folder already has a member with that name: ?filter=eq(name, 'bobsyouruncle')
followReferences	boolean	false	If true, references to other folders are followed when returning the recursive list of members. If recursive is false, then the value of this parameter is meaningless. The default value of this parameter is false.
limit	integer<int64>	false	Maximum number of members to return. The default value is 20.
recursive	boolean	false	If true, the members of the requested folder, plus all of its descendants, are returned in a flat list (no order is guaranteed). Reference members that refer to folders are not followed unless the followReferences parameter is true. The default value of this parameter is false.
sortBy	string	false	Sort returned collection of members. See Sorting in REST APIs. The member collection can be sorted by folders first by using sortBy=eq(contentType,'folder'):descending Use :ascending to soft by folders last. Specifying sortBy=eq(contentType,'folder'):descending,name:ascending,type:ascending sorts by folders first, then by name, then by type.
start	integer<int64>	false	Offset of first member to return. The default value is 0.