API Documentation
Policysets by company GET

get

Policysets by company GET

Retrieve all PolicySets which belongs to the company with specified company id, and of specified entityset type.
A policyset is a grouping of various policies that should be applied concurrently. Policy sets can be applied by name and Id to various parts of the system including storage systems, user groups and allow the administrator to control the various behaviors of the Syncplicity system by the specific attributes of the policy definitions.
Required Scope: Policies, Read

 

URL Parameters

  • Param Name
    Type
    Description
  • COMPANY_GUID
    string
    Unique Id of a company
  • ENTITYSET_TYPE_ID
    string
    Type of the entity set. Valid values: 'PolicySet', 'StorageSet', 'HomeDirectorySet'

Resource URL

https://api.syncplicity.com/ provisioning/policysets.svc/{COMPANY_GUID}/{ENTITYSET_TYPE_ID}

Header Parameters


Name Values Description
AppKey
(required)

Consumer Key of the app from Developer Portal

Accept
(required)

Accept type of the request

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Payload Example


		

Response Payload Schema

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400
    400

    (Bad Request) - Not A Business Admin
    (Bad Request) - Uknown Entity Set Type

  • 403
    403

    (Forbidden) - Request Came From An Unapproved IP Address
    (Forbidden) - Not A Business Admin: The user attempting to execute this request is not a company administrator
    (Forbidden) - Not This Company User: The user attempting to execute this request is not from specifiedcompany

  • 404
    404

    (Not Found) - Wrong Company Id: Company id is invalid Guid
    (Not Found) - Unknown Company Id: Company with specified Id is not found

Working...