Skip Navigation
  1. BlackBerry Docs
  2. BlackBerry Enterprise Mobility Server 3.8
  3. Docs REST API
  4. REST API
  5. REST functions
  6. Repository-related functions

Repository-related functions

Function
REST Call URI
Verb
Description
List repositories
http(s)://{
FQDN of the BEMS-Docs server
}:8443/docs/{
version
}?include=offline
GET
This function lists the repositories. 
Optional parameters
  • include=offline: This parameter specifies that offline information is included in the output and must be in the request uri. 
For an example of a repository list response format, see Repository listing response format.
Retrieve repository metadata
http(s)://{
FQDN of the BEMS-Docs server
}:8443/docs/{
version
}/{
repository
}?metadata=repository?include=offline
GET
This function retrieves the repository metadata. 
Optional parameters
  • include=offline: This parameter specifies that offline information is included in the output and must be in the request uri. 
Add/edit user defined repository
http(s)://{
FQDN of the BEMS-Docs server
}:8443/docs/{
version
}?action=addUserRepository
POST
This function allows adding and editing of the user defined repository. 
The required request body is in the JSON format as shown in the following example: 
{
 "name":"
name
",
 "path":"
path
",
 "storage":"
storage
"
 }
  • The 
    name
     value is the user's display name.
  • The 
    path
     value is the path to the data source. 
  • The 
    storage
     value is any supported physical storage. For example, FileShare or 
    Microsoft SharePoint
    . 
The output is the metadata of the repository added in the JSON format.
Delete user defined repository
http(s)://{
FQDN of the BEMS-Docs server
}:8443/docs/{
version
}/user/{
repository
}
DELETE
This function deletes the user-defined repository.