File Management APIs Directory Resource

This service provides operations for managing directories in the repository.

Create new folder

put

Creates a new folder with the specified name.

Example Request:

PUT pentaho/api/repo/dirs/home:admin:newfolder

cURL Example:

curl -X PUT \
  "http://localhost:8080/pentaho/api/repo/dirs/home:admin:newfolder" \
  -H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="

Authorizations

basicAuth

AuthorizationstringRequired

HTTP Basic Authentication

Path parameters

pathIdstringRequired

The path from the root folder to the root node of the tree to return usingcolon characters in place of / or \ characters. To clarify /path/to/file, the encoded pathId would be :path:to:file.

Example: home:admin:newfolder

Responses

200

Successfully created folder.

No content

403

Forbidden. Cannot create root level folder or contains illegal characters.

text/plain

409

Path already exists.

text/plain

500

Server Error.

put

/repo/dirs/{pathId}

HTTPcURLJavaScriptPython

PUT /repo/dirs/{pathId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Check if folder is visible

get

Determines whether a current user has permission to see the folder or not.

Example Request:

GET pentaho/api/repo/dirs/home:admin:folder/isVisible

cURL Example:

curl -X GET \
  "http://localhost:8080/pentaho/api/repo/dirs/home:admin:folder/isVisible" \
  -H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="

Authorizations

basicAuth

AuthorizationstringRequired

HTTP Basic Authentication

Path parameters

pathIdstringRequired

The path from the root folder to the root node of the tree to return using colon characters in place of / or \ characters. To clarify /path/to/file, the encoded pathId would be :path:to:file.

Example: home:admin:folder

Responses

200

Successfully returns a boolean value, either true or false

text/plain

string · enumOptional

String "true" if the folder is visible to the current user, or "false" otherwise.

Possible values:

get

/repo/dirs/{pathId}/isVisible

HTTPcURLJavaScriptPython

GET /repo/dirs/{pathId}/isVisible HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

Successfully returns a boolean value, either true or false

true

Get default save location

get

Gets the default save location for the specified path.

Example Request:

GET pentaho/api/repo/dirs/home:admin:folder/defaultLocation

cURL Example:

curl -X GET \
  "http://localhost:8080/pentaho/api/repo/dirs/home:admin:folder/defaultLocation" \
  -H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="

Authorizations

basicAuth

AuthorizationstringRequired

HTTP Basic Authentication

Path parameters

pathIdstringRequired

The path from the root folder to the root node of the tree to return using colon characters in place of / or \ characters. To clarify /path/to/file, the encoded pathId would be :path:to:file.

Example: home:admin:folder

Responses

200

Successfully returns a default open/save location

text/plain

stringOptional

Path for a default save location

Example: /public

get

/repo/dirs/{pathId}/defaultLocation

HTTPcURLJavaScriptPython

GET /repo/dirs/{pathId}/defaultLocation HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

Successfully returns a default open/save location

/public