GET /service/api/console/gsm/{gsmKey}/policies/{policyId}

Gets information about a GSM policy.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

string

Required

policyId

The identifier of the policy to query information for.

string

Required

Body Parameters

None.

Response Information

Resource Description

Information about the desired GSM policy.

GetGSMPoliciesResponseModel
NameDescriptionTypeAdditional Information
TotalCount

Total number of policies available.

integer

None.

Deleted

Value (true/false) indicating if any of the policies are deleted.

boolean

None.

Policies

List of policy details records.

Collection of GetGSMPoliciesResponseModel_Policy

None.

Sample Response

{
  "TotalCount": 1,
  "Deleted": false,
  "Policies": [
    {
      "PolicyId": "a4e535c1-a1b6-49bf-9ee9-e3d01ec7b7af",
      "DateCreated": "2019-03-22T21:07:51.6715252Z",
      "PolicyName": "Test Policy 1",
      "LivePolicy": true,
      "PendingPolicy": false,
      "PolicyDescription": "Description of test policy 1",
      "Deleted": false,
      "Canned": false,
      "DefaultSetting": false,
      "PolicyType": "Advanced"
    }
  ]
}                    
<GetGSMPoliciesResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <Deleted>false</Deleted>
  <Policies>
    <GetGSMPoliciesResponseModel_Policy>
      <Canned>false</Canned>
      <DateCreated>2019-03-22T21:07:51.6715252Z</DateCreated>
      <DefaultSetting>false</DefaultSetting>
      <Deleted>false</Deleted>
      <LivePolicy>true</LivePolicy>
      <PendingPolicy>false</PendingPolicy>
      <PolicyDescription>Description of test policy 1</PolicyDescription>
      <PolicyId>a4e535c1-a1b6-49bf-9ee9-e3d01ec7b7af</PolicyId>
      <PolicyName>Test Policy 1</PolicyName>
      <PolicyType>Advanced</PolicyType>
    </GetGSMPoliciesResponseModel_Policy>
  </Policies>
  <TotalCount>1</TotalCount>
</GetGSMPoliciesResponseModel>