RepositoryResource

The following resources are applicable:

/repos/{contextId}/{resourceId }

Mount Point: /api/repos/{contextId}/{resourceId }

POST

Services a HTTP form POST request for a resource identified by the compound key contextId, and resourceId

contextId may be one of:

A. repository file id (colon-delimited path), e.g. :public:steel-wheels:sales.prpt
B. repository file extension, e.g. prpt
C. plugin id

resourceId may be one of:

1. static file residing in a publicly visible plugin folder
2. repository file id (colon-delimited path), e.g. :public:steel-wheels:sales.prpt
3. content generator id

The resolution order is as follows, the first to find the resource wins:

  1. A1
  2. A2
  3. A3
  4. B1
  5. B3
  6. C1
  7. C3

Parameters

name description type default
contextId identifies the context in which the resource should be retrieved path
resourceId identifies a resource to be retrieved path

Request Body

element: (custom)
media types: application/x-www-form-urlencoded

any arguments needed to render the resource

Response Body

element: (custom)
media types: */*
application/xml
application/octet-stream

a JAX-RS Response, in many cases, this will trigger a streaming operation after it it is returned to the caller

GET

Services a HTTP GET request for a resource identified by the compound key contextId, and resourceId. Any HTTP request params are pulled from the GET request and used in rendering the resource.

contextId may be one of:

A. repository file id (colon-delimited path), e.g. :public:steel-wheels:sales.prpt
B. repository file extension, e.g. prpt
C. plugin id

resourceId may be one of:

1. static file residing in a publicly visible plugin folder
2. repository file id (colon-delimited path), e.g. :public:steel-wheels:sales.prpt
3. content generator id

The resolution order is as follows, the first to find the resource wins:

  1. A1
  2. A2
  3. A3
  4. B1
  5. B3
  6. C1
  7. C3

Parameters

name description type default
contextId identifies the context in which the resource should be retrieved path
resourceId identifies a resource to be retrieved path

Response Body

element: (custom)
media types: */*
application/xml
application/octet-stream

a JAX-RS Response, in many cases, this will trigger a streaming operation after it it is returned to the caller

/repos/{pathId }/content

Mount Point: /api/repos/{pathId }/content

GET

Parameters

name description type default
pathId (no documentation provided) path

Response Body

element: (custom)
media types: */*
application/xml
application/octet-stream

(no documentation provided)

/repos/{pathId }/default

Mount Point: /api/repos/{pathId }/default

GET

Parameters

name description type default
pathId (no documentation provided) path

Response Body

element: (custom)
media types: */*
application/xml
application/octet-stream

(no documentation provided)

/repos/executableTypes

Mount Point: /api/repos/executableTypes

GET

Response Body

element: (custom)
media types: application/xml
application/json

(no documentation provided)