The Get Datashare Management Configurations operation will return a list of the basedirectory configurations.
Request
Request URI
| Method | Request URI |
|---|---|
| GET | https://{company-name}.helloid.com/api/v1/datasharemanagementconfig |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
Request headers
None.
Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful and the resource is created. |
| 400(BAD REQUEST) | Indicates that the operation was not successful. The content type was incorrect or the request body was malformed. |
| 401(UNAUTHORIZED) | Indicates that no authentication header was given or the api key and secret were invalid. If the api key and secret were valid check the configuration in your portal, it is possibilty these were IP restricted or are disabled. |
Please also see error result.
Please also see common HTTP status codes.
Response parameters
The response contains a list of base directory configurations.
Variable object
| Parameter | Description |
|---|---|
| dataShareEntryGUID | The GUID of the base directory configuration |
| Name | Name of the configuration |
| Description | Description of the configuration |
| IntegrationGUID | Identifier of the integration |
| GroupPrefix | Prefix that is prepended to groupnames that are linked to the folders |
| GroupOULocation | OU location of the folders |
| MaxDepth | Maximum depth in the folder tree where the manager has access. |
| ManagerGUIDs | List of UserGUIDs of the foldermanagers |
| DataShareFolders | List of base folder names and aliases |
| AllowBaseDirectoryManagement | Determines whether base directory management is allowed |
| AllowRead | Determines whether read access is allowed |
| AllowReadWrite | Determines whether read/write access is allowed |
| AllowFullControl | Determines whether full control is allowed |
Sample response body
[
{
"dataShareEntryGUID": "0b208581-71a7-4fbb-8aec-3755c9976047",
"name": "Test",
"description": "Test description",
"integrationGUID": "036a9b9b-a9c1-4fe3-8b8b-04f5645cd2d1",
"groupPrefix": "T",
"groupOULocation": "Test",
"maxDepth": 3,
"managerGuids": [
"96db8db0-bcc1-4787-b481-64a5c9061327"
],
"dataShareFolders": [
{
"folder": "C:\\",
"alias": "System Volume"
},
{
"folder": "D:\\",
"alias": "Documents"
}
],
"allowBaseDirectoryManagement": false,
"allowRead": true,
"allowReadWrite": false,
"allowFullControl": false
}
]
Example request with cURL
Replace placeholder values surrounded by { } with the actual values.
curl -u {api-key}:{api-secret} -X GET https://{company-name}.helloid.com/api/v1/datasharemanagementconfig