The Update Datashare Management Configuration operation will update an existing datashare configuration using the specified request body.
Request
Request URI
| Method | Request URI |
|---|---|
| PUT | https://{company-name}.helloid.com/api/v1/datasharemanagementconfig/{dataShareEntryGuid} |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
| {dataShareEntryGuid} | The identifier of the basedirectory configuration |
Request headers
| Header | Description |
|---|---|
| Content-Type | Required. Must be set to application/json. |
Sample request body
{
"name": "New Name",
"integrationGUID": "036a9b9b-a9c1-4fe3-8b8b-04f5645cd2d1",
"maxDepth": 1,
"managerGuids": [
"96db8db0-bcc1-4787-b481-64a5c9061327"
],
"dataShareFolders": [
{
"folder": "C:\\",
"alias": "System Volume"
},
{
"folder": "D:\\",
"alias": "Documents"
}
],
"allowBaseDirectoryManagement": false,
"allowRead": true,
"allowReadWrite": false,
"allowFullControl": false
}
Request body parameters
| Parameter | Description | Required/Optional | Default value |
|---|---|---|---|
| {Name} | Name of the configuration | Optional | - |
| {Description} | Description of the configuration | Optional | - |
| {IntegrationGUID} | Identifier of the integration to use | Optional | - |
| {GroupPrefix} | Prefix that will be prepended to groupnames that are linked to the folders | Optional | - |
| {GroupOULocation} | OU location of the folders | Optional | - |
| {MaxDepth} | Maximum depth in the folder tree where the manager has access. | Optional | - |
| {ManagerGuids} | List of UserGUIDs of the foldermanagers | Optional | - |
| {DataShareFolders} | List of base folder names and aliases | Optional | - |
| {AllowBaseDirectoryManagement} | Determines whether base directory management is allowed | Optional | - |
| {AllowRead} | Determines whether read access is allowed | Optional | - |
| {AllowReadWrite} | Determines whether read/write access is allowed | Optional | - |
| {AllowFullControl} | Determines whether full control is allowed | Optional | - |
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. There were validation errors or the request body was malformed.If there were validation errors, the response will include a error result. |
| 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.
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 PUT https://{company-name}.helloid.com/api/v1/datasharemanagementconfig/{dataShareEntryGuid}-H "Content-Type:application/json" -d
"{
"name": "New Name",
"integrationGUID": "036a9b9b-a9c1-4fe3-8b8b-04f5645cd2d1",
"maxDepth": 1,
"managerGuids": [
"96db8db0-bcc1-4787-b481-64a5c9061327"
],
"dataShareFolders": [
{
"folder": "C:\\",
"alias": "System Volume"
},
{
"folder": "D:\\",
"alias": "Documents"
}
],
"allowBaseDirectoryManagement": false,
"allowRead": true,
"allowReadWrite": false,
"allowFullControl": false
}"