search

File Management APIs Repository Resource

This service provides access to repository resources and contexts.

hashtag
Get repository resource

get

Gets a resource identified by the compound key contextId and resourceId. This request may include additional parameters used to render the resource.

Example Request:

GET pentaho/api/repos/admin-plugin/resources/authenticationProviderModule/authenticationProviderAdmin.html

cURL Example:

curl -X GET \
  "http://localhost:8080/pentaho/api/repos/admin-plugin/resources/authenticationProviderModule/authenticationProviderAdmin.html" \
  -H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="
Authorizations
AuthorizationstringRequired

HTTP Basic Authentication

Path parameters
contextIdstringRequired

Identifies the context in which the resource should be retrieved. This value may be a repository file ID, repository file extension or plugin ID.

Example: admin-plugin
resourceIdstringRequired

Identifies a resource to be retrieved. This value may be a static file residing in a publicly visible plugin folder, repository file ID or content generator ID.

Example: resources/authenticationProviderModule/authenticationProviderAdmin.html
Responses
chevron-right
200

Successfully get the resource.

*/*
stringOptional
get
/repos/{contextId}/{resourceId}

hashtag
Get repository resource with form data

post

Gets a resource identified by the compound key contextId and resourceId. This request may include additional parameters used to render the resource.

Example Request:

POST pentaho/api/repos/xanalyzer/service/ajax/lookupXmiId

cURL Example:

curl -X POST \
  "http://localhost:8080/pentaho/api/repos/xanalyzer/service/ajax/lookupXmiId" \
  -H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "catalog=t&cube=t&time=1389817320072"
Authorizations
AuthorizationstringRequired

HTTP Basic Authentication

Path parameters
contextIdstringRequired

Identifies the context in which the resource should be retrieved. This value may be a repository file ID, repository file extension or plugin ID

Example: xanalyzer
resourceIdstringRequired

Identifies a resource to be retrieved. This value may be a static file residing in a publicly visible plugin folder, repository file ID or content generator ID

Example: service/ajax/lookupXmiId
Body
Other propertiesstringOptional
Responses
chevron-right
200

Successfully get the resource.

*/*
stringOptional
post
/repos/{contextId}/{resourceId}

hashtag
Get default URI for file execution

get

Takes a pathId to a file and generates a URI that represents the URL to call to generate content from that file.

Example Request:

GET pentaho/api/repos/public:steel%20wheels:Invoice%20(report).prpt/default

cURL Example:

curl -X GET \
  "http://localhost:8080/pentaho/api/repos/public:steel%20wheels:Invoice%20(report).prpt/default" \
  -H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="
Authorizations
AuthorizationstringRequired

HTTP Basic Authentication

Path parameters
pathIdstringRequired

The path ID to a file

Example: public:steel%20wheels:Invoice%20(report).prpt
Responses
get
/repos/{pathId}/default
No content
PreviousFile Management APIs File ResourceNextFile Management APIs Session Resource

Last updated

Was this helpful?