Initializing help system before first use

RepositoryResource

Exposes repository browsing through the REST API

The following resources are part of this group:

/v1/data/repository/{repositoryPath}

GET

Lists the contents of a repository path.

Parameters

name description type default
repositoryPath The path in the repository to read. For example /project1/folder1 path
start Start at this position in the list. query 0
maxResults The maximum number of items to return. query 50

Response Body

element: webServiceBeanList
media types: application/json

A paginated list of references to contents of the repository path. 404 Not Found if the repository path does not point to a valid container entity. i.e. a project, folder or virtual scenario group

POST

Create a new folder or updates an existing folder or scenario to point to a new repository path.

Parameters

name description type default
repositoryPath the path in the repository to create the folder or move the folder/scenario to. For example:
Multiplication%20Test Project/
path

Request Body

element: reference
media types: application/json

a reference representation of the folder to create or folder/scenario update (sent by the client)

Response Body

element: (custom)
media types: application/json

an response containing the current representation of the folder or scenario

  • 400 Bad Request when the reference id is null or empty and the reference is not a folder
  • 404 Not Found when the target folder (as indicated by the repository path) does not exist
  • 403 Forbidden when not authorized to access the resource