Get a list of folder members

head/folders/{folderId}/members
Internal-Use Only

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.

Request Samples

1

Response Samples

1No example avaliable

Path Parameters

NameTypeRequiredDescription
folderId
string<object-id>
true

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

Query Parameters

NameTypeRequiredDescription
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.

Header Parameters

NameTypeRequiredDescription
Accept-Item
string
false

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-Language
string
false

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

Responses

StatusMeaningDescription
200OKThe request succeeded. A list of folder members was returned.Headers
400Bad RequestThe request was invalid. An invalid filter or combination of request parameters was provided.
404Not FoundNo folder exists at the requested path.