File Management APIs Session Resource

This service provides session-related operations for workspace management.

Get user workspace directory

get

Returns the current user's workspace folder path.

Example Request:

GET pentaho/api/session/userWorkspaceDir

cURL Example:

curl -X GET \
  "http://localhost:8080/pentaho/api/session/userWorkspaceDir" \
  -H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="

Authorizations

basicAuth

Responses

200

Returns the requested file path

text/plain

Responsestring

String object containing the workspace folder path

get

/session/userWorkspaceDir

HTTPcURLJavaScriptPython

GET /session/userWorkspaceDir HTTP/1.1
Host: 
Authorization: Basic username:password
Accept: */*

200

Returns the requested file path

/home/admin/workspace

Get workspace directory for specific user

get

Returns the workspace folder path for the selected user.

Example Request:

GET pentaho/api/session/workspaceDirForUser/admin

cURL Example:

curl -X GET \
  "http://localhost:8080/pentaho/api/session/workspaceDirForUser/admin" \
  -H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="

Authorizations

basicAuth

Path parameters

userstringRequired

String of the user name

Example: admin

Responses

200

Returns the workspace file path for the specified user

text/plain

Responsestring

String object containing the workspace folder path

500

File path failed to be retrieved. This could be caused by an invalid user request

get

/session/workspaceDirForUser/{user}

HTTPcURLJavaScriptPython

GET /session/workspaceDirForUser/{user} HTTP/1.1
Host: 
Authorization: Basic username:password
Accept: */*

workspace