Docs Self-Service web console functions

These functions are available when the user-defined repositories are enabled in the environment. User-defined repositories allow users to view, add, update, and remove the user-defined repositories. For sample calls of these functions, see Docs Self-Service web console examples.

Function

REST Call URI

Verb

Description

Get User Repositories

http(s)://{<FQDN of the BEMS-Docs server>}:8443/docsconsole-sso/data/docs/users/{<email>}/repositories

GET

This function searches the repositories that are assigned to a specific user.

Optional parameters:
  • name: This parameter searches the user's repositories using the full or partial name of the repository.

For an example of user-defined repositories that are assigned to a user, see Get user-defined repositories retrieval.

Get a User Repository

http(s)://{<FQDN of the BEMS-Docs server>}:8443/docsconsole-sso/data/docs/users/{<email>}/repositories/{<repositoryId>}

GET

This function searches for a specific repository that is assigned to a specific user.

For an example of a specific user-defined repository that a user is assigned, see Get specific user-defined repository retrieval.

Create User-Defined Repository

http(s)://{<FQDN of the BEMS-Docs server>}:8443/docsconsole-sso/data/docs/users/{<email>}/repositories

POST

This function creates a user-defined repository.

The required request body is in the JSON format, as shown in the following example: 
{
 "name":"UserDefinedRepository",
 "storagetype":"SharePoint",
 "path":"<homeDirectory>",
 "validatepath":false
}

For an example of creating a user-defined repository output, see User-defined repository output examples.

Delete User-Defined Repository

http(s)://{<FQDN of the BEMS-Docs server>}:8443/docsconsole-sso/data/docs/users/{<email>}/repositories/{<repositoryId>}

DELETE

This function deletes a specific user-defined repository.

For an example of deleting a user-defined repository output, see User-defined repository output examples.

Update User-Defined Repository

http(s)://{<FQDN of the BEMS-Docs server>}:8443/docsconsole-sso/data/docs/users/{<email>}/repositories/{<repositoryId>}

POST

This function updates a specific user-defined repository.

The required request body is in the JSON format, as shown in the following example: 
{
"storagetype" : "SharePoint",
"name":"UserDefinedRepositoryModified",
"path":"http://share1.example.com",
"validatepath":false
}

For an example of updating a user-defined repository output, see User-defined repository output examples.