API Reference for device/activedirectoryhybrid/ADReplicationSite

Model ref.: device/activedirectoryhybrid/ADReplicationSite

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/device/activedirectoryhybrid/ADReplicationSite/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "DisplayName": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "DisplayName", 
               "title": "DisplayName", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "UniversalGroupCachingRefreshSite": {
               "__type_requested": "System.String", 
               "required": false, 
               "description": "Specifies the name of a site. If universal group caching is enabled, the name of the site from which the cache is pulled.", 
               "title": "UniversalGroupCachingRefreshSite", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "UniversalGroupCachingRefreshSite"
          }, 
          "showInAdvancedViewOnly": {
               "__type_requested": "System.Boolean", 
               "required": false, 
               "name": "showInAdvancedViewOnly", 
               "title": "showInAdvancedViewOnly", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "Instance": {
               "__type_requested": "ADReplicationSite", 
               "required": false, 
               "description": "Specifies an instance of a site object to use as a template for a new site object.\nYou can use an instance of an existing site object as a template or you can construct a new site object by using the Windows PowerShell command line or by using a script.\nMethod 1: Use an existing site object as a template for a new object. To retrieve an instance of an existing site object, use the Get-ADReplicationSite cmdlet. Then provide this site object to the Instance parameter of the New-ADReplicationSite cmdlet to create a new site object. You can override property values of the new object by setting the appropriate parameters.\nMethod 2: Create a new ADReplicationSite and set the property values by using the Windows PowerShell command line interface. Then pass this object to the Instance parameter of the New-ADReplicationSite cmdlet to create the new site object.\nNote: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error.", 
               "title": "Instance", 
               "__type_mapping_type": "Unknown", 
               "name": "Instance", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "TopologyCleanupEnabled": {
               "__type_requested": "Boolean", 
               "required": false, 
               "description": "Indicates whether the cmdlet enables topology cleanup. When enabled, prevents the KCC from removing connection objects that it does not need. Disable this option if you want to take responsibility for removing old redundant connections. Alternatively, to control or augment the topology, you can use manual connections, which the KCC does not delete.", 
               "title": "TopologyCleanupEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "TopologyCleanupEnabled"
          }, 
          "instanceType": {
               "__type_requested": "System.Int32", 
               "required": false, 
               "name": "instanceType", 
               "title": "instanceType", 
               "__type_mapping_type": "Integer", 
               "readonly": true, 
               "type": "integer"
          }, 
          "isDeleted": {
               "__type_requested": "System.Boolean", 
               "required": false, 
               "name": "isDeleted", 
               "title": "isDeleted", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "Name": {
               "__type_requested": "String", 
               "required": true, 
               "description": "Specifies a name for the replication site object.", 
               "title": "Name", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Name"
          }, 
          "dSCorePropagationData": {
               "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", 
               "required": false, 
               "name": "dSCorePropagationData", 
               "title": "dSCorePropagationData", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": true, 
               "type": "array"
          }, 
          "ProtectedFromAccidentalDeletion": {
               "__type_requested": "Boolean", 
               "required": false, 
               "description": "Specifies whether to prevent the object from being deleted. When this property is set to $True, you cannot delete the corresponding object without changing the value of the property. The acceptable values for this parameter are:\u00a0\n\n-- $False or 0\n-- $True or 1", 
               "title": "ProtectedFromAccidentalDeletion", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "ProtectedFromAccidentalDeletion"
          }, 
          "Description": {
               "__type_requested": "String", 
               "required": false, 
               "description": "Specifies a description of the object. This parameter sets the value of the Description property for the object. The LDAP Display Name (ldapDisplayName) for this property is description.", 
               "title": "Description", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Description"
          }, 
          "Deleted": {
               "__type_requested": "System.Boolean", 
               "required": false, 
               "name": "Deleted", 
               "title": "Deleted", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "AutomaticInterSiteTopologyGenerationEnabled": {
               "__type_requested": "Boolean", 
               "required": false, 
               "description": "Indicates whether the cmdlet prevents the KCC that functions as the intersite topology generator (ISTG) from generating connections for intersite replication. Use this option when you want to create manual intersite connections (disable the ISTG) but retain the KCC to generate intrasite connections.", 
               "title": "AutomaticInterSiteTopologyGenerationEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "AutomaticInterSiteTopologyGenerationEnabled"
          }, 
          "ObjectGUID": {
               "__type_requested": "System.Nullable`1[[System.Guid,", 
               "required": false, 
               "name": "ObjectGUID", 
               "title": "ObjectGUID", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "LastKnownParent": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "LastKnownParent", 
               "title": "LastKnownParent", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "ManagedBy": {
               "__type_requested": "System.String", 
               "required": false, 
               "description": "Specifies the user or group that manages the object by providing one of the following property values : \n\n-- Distinguished Name\n-- GUID (objectGUID) \n-- Security Identifier (objectSid)\n-- SAM Account Name (sAMAccountName)\n\nNote: The identifier in parentheses is the LDAP display name for the property.\nThis parameter sets the Active Directory attribute with an LDAP Display Name of managedBy.", 
               "title": "ManagedBy", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "ManagedBy"
          }, 
          "ScheduleHashingEnabled": {
               "__type_requested": "Boolean", 
               "required": false, 
               "description": "Indicates whether the cmdlet spreads replication start times randomly across the entire schedule interval rather than just the first quarter of the interval.", 
               "title": "ScheduleHashingEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "ScheduleHashingEnabled"
          }, 
          "whenCreated": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "whenCreated", 
               "title": "whenCreated", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "uSNCreated": {
               "__type_requested": "System.Int64", 
               "required": false, 
               "name": "uSNCreated", 
               "title": "uSNCreated", 
               "__type_mapping_type": "Integer", 
               "readonly": true, 
               "type": "integer"
          }, 
          "ReplicationSchedule": {
               "__type_requested": "System.String", 
               "required": false, 
               "description": "Specifies the default replication schedule for connections within this site (intra-site replication).", 
               "title": "ReplicationSchedule", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "ReplicationSchedule"
          }, 
          "UniversalGroupCachingEnabled": {
               "__type_requested": "Boolean", 
               "required": false, 
               "description": "Indicates whether the cmdlet enables universal group caching. If this parameter is true, it indicates this site caches universal groups, which are those groups cached on global catalog (GC) servers. It can be useful in sites with no GC servers available locally.", 
               "title": "UniversalGroupCachingEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "UniversalGroupCachingEnabled"
          }, 
          "DistinguishedName": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "DistinguishedName", 
               "title": "DistinguishedName", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "AuthType": {
               "__type_requested": "ADAuthType", 
               "required": false, 
               "description": "Specifies the authentication method to use. The acceptable values for this parameter are:\u00a0\n\n-- Negotiate or 0\n-- Basic or 1\nThe default authentication method is Negotiate.\nA Secure Sockets Layer (SSL) connection is required for the Basic authentication method.", 
               "title": "AuthType", 
               "__type_mapping_type": "Unknown", 
               "name": "AuthType", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "CN": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "CN", 
               "title": "CN", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "Created": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "Created", 
               "title": "Created", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "Subnets": {
               "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", 
               "required": false, 
               "name": "Subnets", 
               "title": "Subnets", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": true, 
               "type": "array"
          }, 
          "msExchServerSiteBL": {
               "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", 
               "required": false, 
               "name": "msExchServerSiteBL", 
               "title": "msExchServerSiteBL", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": true, 
               "type": "array"
          }, 
          "createTimeStamp": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "createTimeStamp", 
               "title": "createTimeStamp", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "Server": {
               "__type_requested": "String", 
               "required": false, 
               "description": "Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following:  Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.\nSpecify the Active Directory Domain Services instance in one of the following ways:  \n\n-- Domain name values:\n\n---- Fully qualified domain name\n---- NetBIOS name\n\n-- Directory server values: \n\n---- Fully qualified directory server name\n---- NetBIOS name\n---- Fully qualified directory server name and port\nThe default value for this parameter is determined by one of the following methods in the order that they are listed:\n\n-- By using the Server value from objects passed through the pipeline\n-- By using the server information associated with the Active Directory Domain ServicesWindows PowerShell provider drive, when the cmdlet runs in that drive\n-- By using the domain of the computer running Windows PowerShell", 
               "title": "Server", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Server"
          }, 
          "InterSiteTopologyGenerator": {
               "__type_requested": "System.String", 
               "required": false, 
               "description": "Specifies the server acting as the inter-site topology generator for this site.", 
               "title": "InterSiteTopologyGenerator", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "InterSiteTopologyGenerator"
          }, 
          "Modified": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "Modified", 
               "title": "Modified", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "OtherAttributes": {
               "__type_requested": "Hashtable", 
               "required": false, 
               "description": "Specifies object attribute values for attributes that are not represented by cmdlet parameters. You can set one or more parameters at the same time with this parameter. If an attribute takes more than one value, you can assign multiple values. To identify an attribute, specify the LDAPDisplayName (ldapDisplayName) defined for it in the Active Directory schema.\nSyntax:\nTo specify a single value for an attribute:\n-OtherAttributes @{'AttributeLDAPDisplayName'=value}\nTo specify multiple values for an attribute\n-OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...}\nYou can specify values for more than one attribute by using semicolons to separate attributes.  The following syntax shows how to set values for multiple attributes:\n-OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...}", 
               "title": "OtherAttributes", 
               "__type_mapping_type": "Unknown", 
               "name": "OtherAttributes", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "WindowsServer2000KCCISTGSelectionBehaviorEnabled": {
               "__type_requested": "Boolean", 
               "required": false, 
               "description": "Indicates whether the cmdlet to implements the Windows\u00a02000\u00a0Server method of ISTG selection. Off by default.", 
               "title": "WindowsServer2000KCCISTGSelectionBehaviorEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "WindowsServer2000KCCISTGSelectionBehaviorEnabled"
          }, 
          "AutomaticTopologyGenerationEnabled": {
               "__type_requested": "Boolean", 
               "required": false, 
               "description": "Indicates whether to enable automatic topology generation. When enabled, prevents the KCC from generating intrasite connections on all servers in the site. Disable this option if you use manual connections and do not want the KCC to build connections automatically.", 
               "title": "AutomaticTopologyGenerationEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "AutomaticTopologyGenerationEnabled"
          }, 
          "WindowsServer2003KCCBehaviorEnabled": {
               "__type_requested": "Boolean", 
               "required": false, 
               "description": "Implements KCC operation that is consistent with Windows\u00a0Server\u00a02003 forest functional level. This option can be set if all domain controllers in the site are running Windows\u00a0Server\u00a02003.", 
               "title": "WindowsServer2003KCCBehaviorEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "WindowsServer2003KCCBehaviorEnabled"
          }, 
          "whenChanged": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "whenChanged", 
               "title": "whenChanged", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "WindowsServer2000BridgeheadSelectionMethodEnabled": {
               "__type_requested": "Boolean", 
               "required": false, 
               "description": "Implements the Windows\u00a02000\u00a0Server method of selecting a single bridgehead server per directory partition and transport.", 
               "title": "WindowsServer2000BridgeheadSelectionMethodEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "WindowsServer2000BridgeheadSelectionMethodEnabled"
          }, 
          "TopologyMinimumHopsEnabled": {
               "__type_requested": "Boolean", 
               "required": false, 
               "description": "Indicates whether the cmdlet enables topology minimium hops. When enabled, prevents the KCC from generating optimizing connections in the ring topology of intrasite replication. Optimizing connections reduce the replication latency in the site and disabling them is not recommended.", 
               "title": "TopologyMinimumHopsEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "TopologyMinimumHopsEnabled"
          }, 
          "ObjectCategory": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "ObjectCategory", 
               "title": "ObjectCategory", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "WindowsServer2003KCCSiteLinkBridgingEnabled": {
               "__type_requested": "Boolean", 
               "required": false, 
               "description": "Indicates whether the cmdlet enables site link bridging. When the forest functional level Windows\u00a0Server\u00a02003 or Windows\u00a0Server\u00a02003 interim is in effect, provides KCC control of the ability to enable or disable site link bridging.", 
               "title": "WindowsServer2003KCCSiteLinkBridgingEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "WindowsServer2003KCCSiteLinkBridgingEnabled"
          }, 
          "CanonicalName": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "CanonicalName", 
               "title": "CanonicalName", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "ObjectClass": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "ObjectClass", 
               "title": "ObjectClass", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "systemFlags": {
               "__type_requested": "System.Int32", 
               "required": false, 
               "name": "systemFlags", 
               "title": "systemFlags", 
               "__type_mapping_type": "Integer", 
               "readonly": true, 
               "type": "integer"
          }, 
          "uSNChanged": {
               "__type_requested": "System.Int64", 
               "required": false, 
               "name": "uSNChanged", 
               "title": "uSNChanged", 
               "__type_mapping_type": "Integer", 
               "readonly": true, 
               "type": "integer"
          }, 
          "Credential": {
               "__type_requested": "PSCredential", 
               "required": false, 
               "description": "Specifies a user account that has permission to perform this action. The default is the current user.\nType a user name, such as User01 or Domain01\\User01, or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. If you type a user name, you will be prompted for a password.\nThis parameter is not supported by any providers installed with Windows PowerShell.", 
               "title": "Credential", 
               "__type_mapping_type": "Unknown", 
               "name": "Credential", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "TopologyDetectStaleEnabled": {
               "__type_requested": "Boolean", 
               "required": false, 
               "description": "Indicates whether the cmdlet enables topology detect stale. Prevents the KCC from excluding servers that are unreachable from the topology; that is, the KCC does use an alternate server to reroute replication. Use this option only if network communication is very unstable and brief outages are expected.", 
               "title": "TopologyDetectStaleEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "TopologyDetectStaleEnabled"
          }, 
          "WindowsServer2003KCCIgnoreScheduleEnabled": {
               "__type_requested": "Boolean", 
               "required": false, 
               "description": "Indicates whether to ignore schedules. When the forest functional level Windows\u00a0Server\u00a02003 or Windows\u00a0Server\u00a02003 interim is in effect, provides KCC control of the ability to ignore schedules (replication occurs at the designated intervals and is always available).", 
               "title": "WindowsServer2003KCCIgnoreScheduleEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "WindowsServer2003KCCIgnoreScheduleEnabled"
          }, 
          "RedundantServerTopologyEnabled": {
               "__type_requested": "Boolean", 
               "required": false, 
               "description": "Indicates whether the cmdlet creates redundant connections between sites before a failure takes place. When enabled, disables KCC failover. Requires that automatic detection of failed connections also be disabled (+IS_TOPL_DETECT_STALE_DISABLED).", 
               "title": "RedundantServerTopologyEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "RedundantServerTopologyEnabled"
          }, 
          "modifyTimeStamp": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "modifyTimeStamp", 
               "title": "modifyTimeStamp", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "sDRightsEffective": {
               "__type_requested": "System.Int32", 
               "required": false, 
               "name": "sDRightsEffective", 
               "title": "sDRightsEffective", 
               "__type_mapping_type": "Integer", 
               "readonly": true, 
               "type": "integer"
          }
     }, 
     "schema_version": "69"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/activedirectoryhybrid/ADReplicationSite/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/activedirectoryhybrid/ADReplicationSite as JSON

The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.

Task	Call	URL	Parameters	Payload
Create	POST	/api/device/activedirectoryhybrid/ADReplicationSite/	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

tool/Transaction/[trans pkid]

to inspect the created resource and its instance pkid.

Task	Call	URL	Parameters	Payload
Bulk delete [pkid1],[pkid2]...	DELETE	/api/device/activedirectoryhybrid/ADReplicationSite/	hierarchy=[hierarchy]	{"hrefs":["/api/device/activedirectoryhybrid/ADReplicationSite/[pkid1]", "/api/device/activedirectoryhybrid/ADReplicationSite/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: device/activedirectoryhybrid/ADReplicationSite
```
GET http://[host-proxy]/api/device/activedirectoryhybrid/ADReplicationSite/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/activedirectoryhybrid/ADReplicationSite/bulk_update/?schema=&schema_rules=true	hierarchy=[hierarchy] format=json pkids=pkid1,pkid2,...	In JSON format: POST call to update the instances of device/activedirectoryhybrid/ADReplicationSite device/activedirectoryhybrid/ADReplicationSite schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/activedirectoryhybrid/ADReplicationSite/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/activedirectoryhybrid/ADReplicationSite/[pkid1]", "/api/v0/device/activedirectoryhybrid/ADReplicationSite/[pkid2]",...]}}

To get a list of model instance pkids that are available to Bulk Modify, use the GET call:

GET http://[host-proxy]/api/device/activedirectoryhybrid/ADReplicationSite/?hierarchy=[hierarchy]&format=json

The POST payload is in JSON format (refer to the Payload example) and contains:
- data in name-value update pairs according to the returned schema
- meta (empty - for a valid payload)
- request_meta with the hrefs list of instances to update

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/activedirectoryhybrid/ADReplicationSite	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/activedirectoryhybrid/ADReplicationSite/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/activedirectoryhybrid/ADReplicationSite	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/activedirectoryhybrid/ADReplicationSite/[pkid1]", "/api/device/activedirectoryhybrid/ADReplicationSite/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/device/activedirectoryhybrid/ADReplicationSite/?hierarchy=[hierarchy]&format=json&schema_rules=true

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/activedirectoryhybrid/ADReplicationSite; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/activedirectoryhybrid/ADReplicationSite/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/activedirectoryhybrid/ADReplicationSite/[pkid1]", "/api/device/activedirectoryhybrid/ADReplicationSite/[pkid2]",...]}}

For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

The XLSX format can be used to bulk load instances of device/activedirectoryhybrid/ADReplicationSite and the JSON format can be used to import instances of device/activedirectoryhybrid/ADReplicationSite.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for device/activedirectoryhybrid/ADReplicationSite:

 GET http://[host-proxy]/api/device/activedirectoryhybrid/ADReplicationSite/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for device/activedirectoryhybrid/ADReplicationSite	POST	/api/device/activedirectoryhybrid/ADReplicationSite/export_bulkload_template/	hierarchy=[hierarchy] modeltype=device/activedirectoryhybrid/ADReplicationSite	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/activedirectoryhybrid/ADReplicationSite/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/activedirectoryhybrid/ADReplicationSite/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/device/activedirectoryhybrid/ADReplicationSite/	hierarchy=[hierarchy] format=json schema=true	The device/activedirectoryhybrid/ADReplicationSite schema and all instances as JSON.

(The list will return 0 to 3 device/activedirectoryhybrid/ADReplicationSite instances)

GET http://[host]/api/device/activedirectoryhybrid/ADReplicationSite/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "Name", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/activedirectoryhybrid/ADReplicationSite/?skip=0&limit=3&order_by=Name&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "meta": {
          "tags": [], 
          "cached": true, 
          "title": "", 
          "business_key": {}, 
          "schema_version": "69", 
          "references": {
               "device": [
                    {
                         "pkid": "", 
                         "href": ""
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "add": {
                         "support_async": false, 
                         "class": "add", 
                         "href": "/api/device/activedirectoryhybrid/ADReplicationSite/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/activedirectoryhybrid/ADReplicationSite/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/activedirectoryhybrid/ADReplicationSite/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", 
                         "method": "GET", 
                         "title": "Bulk Modify"
                    }
               }, 
               {
                    "move": {
                         "title": "Move", 
                         "support_async": true, 
                         "class": "move", 
                         "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/activedirectoryhybrid/ADReplicationSite", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/activedirectoryhybrid/ADReplicationSite/export/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export_bulkload_template": {
                         "support_async": false, 
                         "class": "bulkload_template", 
                         "href": "/api/device/activedirectoryhybrid/ADReplicationSite/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/activedirectoryhybrid/ADReplicationSite/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/activedirectoryhybrid/ADReplicationSite/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/activedirectoryhybrid/ADReplicationSite/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/activedirectoryhybrid/ADReplicationSite/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/activedirectoryhybrid/ADReplicationSite/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/activedirectoryhybrid/ADReplicationSite", 
          "model_specific_actions": [
               "get", 
               "list", 
               "add", 
               "remove", 
               "update", 
               "bulk_update_form", 
               "clone", 
               "configuration_template", 
               "export", 
               "export_bulkload_template", 
               "field_display_policy", 
               "help", 
               "move"
          ], 
          "summary_attrs": [
               {
                    "name": "Name", 
                    "title": "Name"
               }, 
               {
                    "name": "Description", 
                    "title": "Description"
               }, 
               {
                    "allow_filtering": true, 
                    "name": "hierarchy_friendly_name", 
                    "title": "Located At"
               }
          ], 
          "api_version": "20.1.1", 
          "tagged_versions": []
     }, 
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for device/activedirectoryhybrid/ADReplicationSite.	GET	/api/device/activedirectoryhybrid/ADReplicationSite/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/activedirectoryhybrid/ADReplicationSite as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/device/activedirectoryhybrid/ADReplicationSite/[pkid]/	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/device/activedirectoryhybrid/ADReplicationSite/[pkid]/	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/activedirectoryhybrid/ADReplicationSite/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for device/activedirectoryhybrid/ADReplicationSite

GET http://[host-proxy]/api/device/activedirectoryhybrid/ADReplicationSite/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=device/activedirectoryhybrid/ADReplicationSite	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Response
Get a selected [export_format] of the schema and a single instance with [pkid] of device/activedirectoryhybrid/ADReplicationSite; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/activedirectoryhybrid/ADReplicationSite/[pkid]/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	The response is an attachment. Refer to the list below.

For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=json, the response is a time stamped zip file of data in JSON and a response format:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/device/activedirectoryhybrid/ADReplicationSite/[pkid]/	hierarchy=[hierarchy]	The device/activedirectoryhybrid/ADReplicationSite instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/device/activedirectoryhybrid/ADReplicationSite/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for device/activedirectoryhybrid/ADReplicationSite.

Task	Call	URL	Parameters	Payload
Purge	POST	/api/device/activedirectoryhybrid/ADReplicationSite/[pkid]/purge/	hierarchy=[hierarchy]	If payload required:

API Reference for device/activedirectoryhybrid/ADReplicationSite

GET http://[host-proxy]/api/device/activedirectoryhybrid/ADReplicationSite/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

GET http://[host]/api/device/activedirectoryhybrid/ADReplicationSite/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Purge