Home Page > GET api/siteCollectionReport/get

Gets a list of all Governance Automation Online managed site collections.

Examples

C#

string url = "https://iamgaoapiurl/api/siteCollectionReport/get";
            string logonToken = GetLogonToken();
            HttpWebRequest httpRequest = (HttpWebRequest)HttpWebRequest.Create(url);
            httpRequest.ContentType = "application/json";
            ServicePointManager.ServerCertificateValidationCallback += ((sender, certificate, chain, sslPolicyErrors) => true);
            httpRequest.Method = "GET";
            httpRequest.Headers.Set("X_GovernanceAutomation_Access_Token", logonToken);
            
            //Get response on the web request from Governance Automation Online Web API.
            JArray scReportCollection = null;
            HttpWebResponse response = (HttpWebResponse)httpRequest.GetResponse();
            using (Stream responseStream = response.GetResponseStream())
            {
                using (StreamReader responseReader = new StreamReader(responseStream, Encoding.UTF8))
                {
                    string reply = responseReader.ReadToEnd();
                    scReportCollection = JsonConvert.DeserializeObject(reply) as JArray;
                }
            }
            foreach(var reportObj in scReportCollection)
            {
                JObject scReport = reportObj as JObject;
                string scURL = scReport.GetValue("URL").Value ();
            };

Response Information

Collection of APISiteCollectionReport

Request Information

URI Parameters

NameDescriptionType
URL

Gets a site collection URL.

string
Department

Gets a site collection department.

string
Title

Gets a site collection title.

string
Description

Gets a site collection description.

string
Policy

Gets the site collection policy that is applied to a site collection.

string
SiteCollectionTemplate

Gets the site collection template that is applied to a site collection.

string
SecurityGroupType

Gets the security group type of a site collection.

string
PrimarySiteCollectionAdmin

Gets the primary site collection administrator.

string
PrimarySiteCollectionContact

Gets the primary site collection contact.

string
SecondarySiteCollectionContact

Gets the secondary site collection contact.

string
MetadataValues

Gets the custom metadata that is applied to a site collection.

Dictionary of string [key] and string [value]
CreatedTime

Gets the time when a site collection is created.

date
Size

Gets the size of a site collection.

integer
EnableSPDesigner

Gets a boolean value that shows if SharePoint Designer is enabled on a site collection.

boolean
ExpiredDate

Gets the lease period expiration time of a site collection.

date
NoAccessThreshold

Gets the inactivity threshold time of a site collection.

date
SiteMaxDepth

Get the site maximum depth of a site collection.

integer
SiteStatus

Gets the status of a site collection.

APISiteStatus
PolicyEnforcerProfile

Gets the DocAve Online Policy Enforcer profile that is applied to a site collection.

string
DeploymentManagerPlan

Gets the DocAve Online Deployment Manager plans that are applied to a site collection.

string
RecertificationProfile

Gets the recertification profile that is applied to a site collection.

string
PermissionRecertificationStatus

Gets the status of the permission recertification process that is enabled on a site collection.

string
MetadataRecertificationStatus

Gets the status of the metadata recertification process that is enabled on a site collection.

string
OwnershipRecertificationStatus

Gets the status of the ownership recertification process that is enabled on a site collection.

string
ClaimStatus

Gets the claim status of a site collection contact election process.

string
EnableGranularBackup

Gets a boolean value that shows if Granular Backup is enabled on a site collection.

boolean
EnableAuditing

Gets a boolean value that shows if Auditing is enabled on a site collection.

boolean
SharingCapabilities

Gets the SharingCapabilities property of a site collection. The property value shows how the site collection is shared with external users.

string

Response Formats

application/json, text/json

Sample:
[
  {
    "URL": "sample string 1",
    "Department": "sample string 2",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "Policy": "sample string 5",
    "SiteCollectionTemplate": "sample string 6",
    "SecurityGroupType": "sample string 7",
    "PrimarySiteCollectionAdmin": "sample string 8",
    "PrimarySiteCollectionContact": "sample string 9",
    "SecondarySiteCollectionContact": "sample string 10",
    "MetadataValues": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "CreatedTime": "2015-04-16T15:25:49.0875501+08:00",
    "Size": 12,
    "EnableSPDesigner": true,
    "ExpiredDate": "2015-04-16T15:25:49.0895033+08:00",
    "NoAccessThreshold": "2015-04-16T15:25:49.0895033+08:00",
    "SiteMaxDepth": 1,
    "SiteStatus": 0,
    "PolicyEnforcerProfile":"sample string 11"
    "DeploymentManagerPlan":"sample string 12",
    "RecertificationProfile": "sample string 13",
    "PermissionRecertificationStatus": "sample string 14",
    "MetadataRecertificationStatus": "sample string 15",
    "OwnershipRecertificationStatus": "sample string 16",
    "ClaimStatus": "sample string 17",
    "EnableGranularBackup":true,
    "EnableAuditing":true,
    "SharingCapabilities":"sample string 18",
  },
  {
    "URL": "sample string 1",
    "Department": "sample string 2",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "Policy": "sample string 5",
    "SiteCollectionTemplate": "sample string 6",
    "SecurityGroupType": "sample string 7",
    "PrimarySiteCollectionAdmin": "sample string 8",
    "PrimarySiteCollectionContact": "sample string 9",
    "SecondarySiteCollectionContact": "sample string 10",
    "MetadataValues": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "CreatedTime": "2015-04-16T15:25:49.0875501+08:00",
    "Size": 12,
    "EnableSPDesigner": true,
    "ExpiredDate": "2015-04-16T15:25:49.0895033+08:00",
    "NoAccessThreshold": "2015-04-16T15:25:49.0895033+08:00",
    "SiteMaxDepth": 1,
    "SiteStatus": 0,
    "PolicyEnforcerProfile":"sample string 11"
    "DeploymentManagerPlan":"sample string 12",
    "RecertificationProfile": "sample string 13",
    "PermissionRecertificationStatus": "sample string 14",
    "MetadataRecertificationStatus": "sample string 15",
    "OwnershipRecertificationStatus": "sample string 16",
    "ClaimStatus": "sample string 17",
    "EnableGranularBackup":true,
    "EnableAuditing":true,
    "SharingCapabilities":"sample string 18",
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPISiteCollectionReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AvePoint.GA.WebAPI.Models">
  <APISiteCollectionReport>
    <CreatedTime>2015-04-16T15:25:49.0875501+08:00</CreatedTime>
    <Department>sample string 2</Department>
    <Description>sample string 4</Description>
    <EnableSPDesigner>true</EnableSPDesigner>
    <ExpiredDate>2015-04-16T15:25:49.0895033+08:00</ExpiredDate>
    <MetadataValues xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </MetadataValues>
    <NoAccessThreshold>2015-04-16T15:25:49.0895033+08:00</NoAccessThreshold>
    <PolicyEnforcerProfile>sample string 11</PolicyEnforcerProfile>
    <DeploymentManagerPlan>sample string 12</DeploymentManagerPlan>
    <RecertificationProfile>sample string 13</RecertificationProfile>
    <PermissionRecertificationStatus>sample string 14</PermissionRecertificationStatus>
    <MetadataRecertificationStatus>sample string 15</MetadataRecertificationStatus>
    <OwnershipRecertificationStatus>sample string 16</OwnershipRecertificationStatus>
    <ClaimStatus>sample string 17</ClaimStatus>
    <EnableGranularBackup>true</EnableGranularBackup>
    <EnableAuditing>true</EnableAuditing>
    <SharingCapabilities>sample string 18</SharingCapabilities>
    <Policy>sample string 5</Policy>
    <PrimarySiteCollectionAdmin>sample string 8</PrimarySiteCollectionAdmin>
    <PrimarySiteCollectionContact>sample string 9</PrimarySiteCollectionContact>
    <SecondarySiteCollectionContact>sample string 10</SecondarySiteCollectionContact>
    <SecurityGroupType>sample string 7</SecurityGroupType>
    <SiteCollectionTemplate>sample string 6</SiteCollectionTemplate>
    <SiteMaxDepth>1</SiteMaxDepth>
    <SiteStatus>Active</SiteStatus>
    <Size>12</Size>
    <Title>sample string 3</Title>
    <URL>sample string 1</URL>
  </APISiteCollectionReport>
  <APISiteCollectionReport>
    <CreatedTime>2015-04-16T15:25:49.0875501+08:00</CreatedTime>
    <Department>sample string 2</Department>
    <Description>sample string 4</Description>
    <EnableSPDesigner>true</EnableSPDesigner>
    <EnableGranularBackup>true</EnableGranularBackup>
    <EnableAuditing>true</EnableAuditing>
    <SharingCapabilities>sample string 18</SharingCapabilities>
    <ExpiredDate>2015-04-16T15:25:49.0895033+08:00</ExpiredDate>
    <MetadataValues xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </MetadataValues>
    <NoAccessThreshold>2015-04-16T15:25:49.0895033+08:00</NoAccessThreshold>
    <PolicyEnforcerProfile>sample string 11</PolicyEnforcerProfile>
    <DeploymentManagerPlan>sample string 12</DeploymentManagerPlan>
    <RecertificationProfile>sample string 13</RecertificationProfile>
    <PermissionRecertificationStatus>sample string 14</PermissionRecertificationStatus>
    <MetadataRecertificationStatus>sample string 15</MetadataRecertificationStatus>
    <OwnershipRecertificationStatus>sample string 16</OwnershipRecertificationStatus>
    <ClaimStatus>sample string 17</ClaimStatus>
    <Policy>sample string 5</Policy>
    <PrimarySiteCollectionAdmin>sample string 8</PrimarySiteCollectionAdmin>
    <PrimarySiteCollectionContact>sample string 9</PrimarySiteCollectionContact>
    <SecondarySiteCollectionContact>sample string 10</SecondarySiteCollectionContact>
    <SecurityGroupType>sample string 7</SecurityGroupType>
    <SiteCollectionTemplate>sample string 6</SiteCollectionTemplate>
    <SiteMaxDepth>1</SiteMaxDepth>
    <SiteStatus>Active</SiteStatus>
    <Size>12</Size>
    <Title>sample string 3</Title>
    <URL>sample string 1</URL>
  </APISiteCollectionReport>
</ArrayOfAPISiteCollectionReport>