RestApiCategories.platformAdministration.desc

platform_administration

2024.09

2024.08

2023.10

2024.07

2024.10

2024.03

2024.11

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

2023.03

Viya_35

This endpoint can be used by a client to test whether creating or renaming a member would create a naming conflict before actually attempting the operation. When creating a new member, a memberId of @new indicates that the attempted operation would create a new member, where a folderId of @root is a placeholder representing the root level of the folder hierarchy. For example,<br> PUT /commons/validations/folders/@root/members/@new/name?value=TestFolder1&type=folder<br> would check if one could successfully create a root folder named TestFolder1 and respond appropriately.<br> PUT /commons/validations/folders/@myFolder/members/@new/name?value=TestReport1&type=report<br> would check whether a new member named TestReport1 of type report could be added to the user's My Folder.


The identifier of the folder whose members are to be checked. A value of @root indicates checking a root-level folder, and type must be folder.

folderId

If a rename is being attempted, the identifier of the member being renamed. If a new member is being created, the @new placeholder is used.

memberId

value

The type of the member to be tested. Members of the same type have to be named uniquely, so both the new name and type are required.

type

The Type definition name to test against. This must match exactly with the desired value. A null value is compared with null values in the repository.

typeDefName

Sample validation response with a good status

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

The request was successfully processed. The body contains the result, whether the name/type is acceptable.

The name is acceptable. The Accept header was application/json, so no further data is returned.

Example of an error response from the service

Error

The supplied name would create a conflict

Validate that a member can be named or renamed to the given value without creating a conflict

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 summarized representation of a resource. Often used in collection responses when more specific details are not needed.

Resource Summary

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.

Name	Type	Required	Description
typeDefName	string	false	The Type definition name to test against. This must match exactly with the desired value. A null value is compared with null values in the repository.
type	string	true	The type of the member to be tested. Members of the same type have to be named uniquely, so both the new name and type are required.
value	string	true	The name to be tested.

Status	Meaning	Description
200	OK	The request was successfully processed. The body contains the result, whether the name/type is acceptable.	Schema
204	No Content	The name is acceptable. The Accept header was application/json, so no further data is returned.
400	Bad Request	The request was invalid.	Schema
409	Conflict	The supplied name would create a conflict	Schema

Validate that a member can be named or renamed to the given value without creating a conflict

Request Samples

Response Samples

Path Parameters

Query Parameters

Responses