[Index]
Model ref.: device/activedirectoryhybrid/ADReplicationSiteLink
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{ "$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" }, "showInAdvancedViewOnly": { "__type_requested": "System.Boolean", "required": false, "name": "showInAdvancedViewOnly", "title": "showInAdvancedViewOnly", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "Instance": { "__type_requested": "ADReplicationSiteLink", "required": false, "description": "Specifies an instance of a site link object to use as a template for a new site link object.\nYou can use an instance of an existing site link object as a template or you can construct a new site link object by using the Windows PowerShell command line or by using a script.\nMethod 1: Use an existing site link object as a template for a new object. To retrieve an instance of an existing site link object, use a cmdlet such as Get-ADReplicationSiteLink. Then provide this object to the Instance parameter of the New-ADReplicationSiteLink cmdlet to create a new Active Directory object. You can override property values of the new object by setting the appropriate parameters.\nMethod 2: Create a new ADReplicationSiteLink and set the property values by using the Windows PowerShell command line interface. Then pass this object to the Instance parameter of the New-ADReplicationSiteLink cmdlet to create the new site link 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" }, "replInterval": { "__type_requested": "System.Int32", "required": false, "name": "replInterval", "title": "replInterval", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "siteList": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "name": "siteList", "title": "siteList", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "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 the name of the site link. This parameter sets the Name property of the Active Directory object. The LDAP Display Name (ldapDisplayName) of this property is name.", "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": "System.Boolean", "required": false, "name": "ProtectedFromAccidentalDeletion", "title": "ProtectedFromAccidentalDeletion", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "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" }, "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" }, "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" }, "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" }, "InterSiteTransportProtocol": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADInterSiteTransportProtocolType", "required": false, "description": "Specifies a valid intersite transport protocol option. The acceptable values for this parameter are:\u00a0\n\n-- IP\n-- SMTP", "title": "InterSiteTransportProtocol", "__type_mapping_type": "Unknown", "name": "InterSiteTransportProtocol", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ReplicationSchedule": { "__type_requested": "System.String", "required": false, "description": "Specifies the default replication schedule for any connections within this site link (intra-site replication). This allows you to schedule the availability of site links for use by replication. By default, a site link is available to carry replication traffic 24 hours a day, 7 days a week. You can limit this schedule to specific days of the week and times of day. You can, for example, schedule intersite replication so that it only occurs after normal business hours.", "title": "ReplicationSchedule", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "ReplicationSchedule" }, "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" }, "Modified": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "Modified", "title": "Modified", "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" }, "createTimeStamp": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "createTimeStamp", "title": "createTimeStamp", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "whenChanged": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "whenChanged", "title": "whenChanged", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "SitesIncluded": { "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", "required": false, "description": "Specifies the list of sites included in the site link.", "title": "SitesIncluded", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "name": "SitesIncluded" }, "Cost": { "__type_requested": "Int32", "required": false, "description": "Specifies the cost to be placed on the site link. For more information on determining the cost, see Determining the Cost in the TechNet Library: http://go.microsoft.com/fwlink/?LinkId=221871.", "title": "Cost", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "Cost" }, "ReplicationFrequencyInMinutes": { "__type_requested": "Int32", "required": false, "description": "Species the frequency, in minutes, for which replication will occur where this site link is in use between sites. Active Directory preserves bandwidth between sites by minimizing the frequency of replication and by allowing you to schedule the availability of site links for replication. By default, intersite replication across each site link occurs every 180 minutes (3 hours). You can adjust this frequency to match your specific needs. Be aware that increasing this frequency increases the amount of bandwidth used by replication.", "title": "ReplicationFrequencyInMinutes", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "ReplicationFrequencyInMinutes" }, "ObjectCategory": { "__type_requested": "System.String", "required": false, "name": "ObjectCategory", "title": "ObjectCategory", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "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 the user account credentials to use to perform this task. The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the default.\nTo specify this parameter, you can type a user name, such as User1 or Domain01\\User01 or you can specify a PSCredential object. If you specify a user name for this parameter, the cmdlet prompts for a password.\nYou can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. You can then set the Credential parameter to the PSCredential object.\nIf the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error.", "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" }, "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/ADReplicationSiteLink/add/ |
|
The GUI Add form of device/activedirectoryhybrid/ADReplicationSiteLink 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/ADReplicationSiteLink/ | hierarchy=[hierarchy] |
|
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/ADReplicationSiteLink/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/activedirectoryhybrid/ADReplicationSiteLink/[pkid1]", "/api/device/activedirectoryhybrid/ADReplicationSiteLink/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/activedirectoryhybrid/ADReplicationSiteLink/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/activedirectoryhybrid/ADReplicationSiteLink/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/activedirectoryhybrid/ADReplicationSiteLink/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/activedirectoryhybrid/ADReplicationSiteLink/[pkid1]", "/api/v0/device/activedirectoryhybrid/ADReplicationSiteLink/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/activedirectoryhybrid/ADReplicationSiteLink/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/activedirectoryhybrid/ADReplicationSiteLink |
|
{"hrefs": ["/api/device/activedirectoryhybrid/ADReplicationSiteLink/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/activedirectoryhybrid/ADReplicationSiteLink |
|
{"hrefs": ["/api/device/activedirectoryhybrid/ADReplicationSiteLink/[pkid1]", "/api/device/activedirectoryhybrid/ADReplicationSiteLink/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/activedirectoryhybrid/ADReplicationSiteLink; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/activedirectoryhybrid/ADReplicationSiteLink/export/ |
|
{ "hrefs":["/api/device/activedirectoryhybrid/ADReplicationSiteLink/[pkid1]", "/api/device/activedirectoryhybrid/ADReplicationSiteLink/[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/ADReplicationSiteLink and the JSON format can be used to import instances of device/activedirectoryhybrid/ADReplicationSiteLink.
GET http://[host-proxy]/api/device/activedirectoryhybrid/ADReplicationSiteLink/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/activedirectoryhybrid/ADReplicationSiteLink | POST | /api/device/activedirectoryhybrid/ADReplicationSiteLink/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/device/activedirectoryhybrid/ADReplicationSiteLink/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/activedirectoryhybrid/ADReplicationSiteLink/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/activedirectoryhybrid/ADReplicationSiteLink/ |
|
The device/activedirectoryhybrid/ADReplicationSiteLink schema and all instances as JSON. |
(The list will return 0 to 3 device/activedirectoryhybrid/ADReplicationSiteLink instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/activedirectoryhybrid/ADReplicationSiteLink/?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/ADReplicationSiteLink/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/activedirectoryhybrid/ADReplicationSiteLink/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/activedirectoryhybrid/ADReplicationSiteLink/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/ADReplicationSiteLink", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/activedirectoryhybrid/ADReplicationSiteLink/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/ADReplicationSiteLink/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/activedirectoryhybrid/ADReplicationSiteLink/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/activedirectoryhybrid/ADReplicationSiteLink/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/activedirectoryhybrid/ADReplicationSiteLink/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/activedirectoryhybrid/ADReplicationSiteLink/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/activedirectoryhybrid/ADReplicationSiteLink/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/activedirectoryhybrid/ADReplicationSiteLink", "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": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/activedirectoryhybrid/ADReplicationSiteLink. | GET | /api/device/activedirectoryhybrid/ADReplicationSiteLink/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/activedirectoryhybrid/ADReplicationSiteLink as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/activedirectoryhybrid/ADReplicationSiteLink/[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/ADReplicationSiteLink/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/activedirectoryhybrid/ADReplicationSiteLink/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/activedirectoryhybrid/ADReplicationSiteLink/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/activedirectoryhybrid/ADReplicationSiteLink | 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/ADReplicationSiteLink; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/activedirectoryhybrid/ADReplicationSiteLink/[pkid]/export/ |
|
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
The XLSX format can be used to bulk load instances of device/activedirectoryhybrid/ADReplicationSiteLink and the JSON format can be used to import instances of device/activedirectoryhybrid/ADReplicationSiteLink.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/activedirectoryhybrid/ADReplicationSiteLink/[pkid]/ | hierarchy=[hierarchy] | The device/activedirectoryhybrid/ADReplicationSiteLink instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/activedirectoryhybrid/ADReplicationSiteLink/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/activedirectoryhybrid/ADReplicationSiteLink. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/activedirectoryhybrid/ADReplicationSiteLink/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |