View Shared Files and Folders

This operation lists the share details of all the shares or a specific share for a user.

More Details

application/json

Request Body

• propertyLevel integer
• shareInfo object

  shareFolder object

  syncWebFolderId integer

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• shares object[]

  userPermission integer

  description string

  shareType integer

  canReshare boolean

  hasReshares integer

  canUserEdit boolean

  status integer

  owner object

  userName string

  userId integer

  sharedTo object[]

  userHasReshares integer

  userStatus integer

  permission integer

  userType integer

  email string

  externalGroup object

  sharedBy object

  userId integer

  user object

  group object

  shareFolder object

  syncWebFolderId integer

  syncWebFolderName string

  browseInfo object

  edgeClient boolean

  paths object[]

  path string

  directory boolean

  expirationTime object

  time integer

  emailInfo object

  emailMessage string

  browseUrl string

  dontSendEmail boolean

  client object

  clientName string

  backupsetId integer

  instanceId integer

  subclientId integer

  clientId integer

  applicationId integer

  lastModified object

  timeValue string

{
  "shares": [
    {
      "userPermission": 0,
      "description": "string",
      "shareType": 0,
      "canReshare": true,
      "hasReshares": 0,
      "canUserEdit": true,
      "status": 0,
      "owner": {
        "userName": "string",
        "userId": 0
      },
      "sharedTo": [
        {
          "userHasReshares": 0,
          "userStatus": 0,
          "permission": 0,
          "userType": 0,
          "email": "string",
          "externalGroup": {},
          "sharedBy": {
            "userId": 0
          },
          "user": {},
          "group": {}
        }
      ],
      "shareFolder": {
        "syncWebFolderId": 0,
        "syncWebFolderName": "string"
      },
      "browseInfo": {
        "edgeClient": true,
        "paths": [
          {
            "path": "string",
            "directory": true
          }
        ],
        "expirationTime": {
          "time": 0
        },
        "emailInfo": {
          "emailMessage": "string",
          "browseUrl": "string",
          "dontSendEmail": true
        }
      },
      "client": {
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientId": 0,
        "clientId": 0,
        "applicationId": 0
      },
      "lastModified": {
        "timeValue": "string"
      }
    }
  ]
}

{
  "shares": [
    {
      "userPermission": 1,
      "description": "",
      "shareType": 2,
      "canReshare": false,
      "hasReshares": 0,
      "canUserEdit": false,
      "status": 0,
      "owner": {
        "userName": "edgeuser",
        "userId": 4
      },
      "sharedTo": [
        {
          "userHasReshares": 0,
          "userStatus": 0,
          "permission": 1,
          "userType": 2,
          "email": "snasim@commvault.com",
          "externalGroup": {},
          "sharedBy": {
            "userId": 4
          },
          "user": {},
          "group": {}
        }
      ],
      "shareFolder": {
        "syncWebFolderId": 703241,
        "syncWebFolderName": "netstat"
      },
      "browseInfo": {
        "edgeClient": false,
        "paths": [
          {
            "path": "C:\\netstat.txt",
            "directory": false
          }
        ],
        "expirationTime": {
          "time": 0
        },
        "emailInfo": {
          "emailMessage": "",
          "browseUrl": "/webconsole/gtl.do?gid=acV5rp8",
          "dontSendEmail": false
        }
      },
      "client": {
        "clientName": "firewalltestma",
        "backupsetId": 20,
        "instanceId": 1,
        "subclientId": 70,
        "clientId": 9,
        "applicationId": 33
      },
      "lastModified": {
        "timeValue": "1496310616"
      }
    }
  ]
}

POST /getsharedfolders    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• View Shared Files and Folders - To view the share details of a specific shared file

---

{
  "propertyLevel": 0,
  "shareInfo": {
    "shareFolder": {
      "syncWebFolderId": 0
    }
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/GetSharedFolders' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "propertyLevel": 0,
  "shareInfo": {
    "shareFolder": {
      "syncWebFolderId": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/GetSharedFolders' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "propertyLevel": 0,
  "shareInfo": {
    "shareFolder": {
      "syncWebFolderId": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/GetSharedFolders' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "propertyLevel": 0,
  "shareInfo": {
    "shareFolder": {
      "syncWebFolderId": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/GetSharedFolders' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "propertyLevel": 0,
  "shareInfo": {
    "shareFolder": {
      "syncWebFolderId": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/GetSharedFolders' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "propertyLevel": 0,
  "shareInfo": {
    "shareFolder": {
      "syncWebFolderId": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/GetSharedFolders' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "propertyLevel": 0,
  "shareInfo": {
    "shareFolder": {
      "syncWebFolderId": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/GetSharedFolders' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "propertyLevel": 0,
  "shareInfo": {
    "shareFolder": {
      "syncWebFolderId": 0
    }
  }
}'