API Reference for device/activedirectoryhybrid/ADOrganizationalUnit

Model ref.: device/activedirectoryhybrid/ADOrganizationalUnit

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/ADOrganizationalUnit/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "City": {
               "__type_requested": "String", 
               "required": false, 
               "description": "Specifies the user's town or city. This parameter sets the City property of a user. The LDAP display name (ldapDisplayName) of this property is l.", 
               "title": "City", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "City"
          }, 
          "isCriticalSystemObject": {
               "__type_requested": "System.Boolean", 
               "required": false, 
               "name": "isCriticalSystemObject", 
               "title": "isCriticalSystemObject", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "DisplayName": {
               "__type_requested": "String", 
               "required": false, 
               "description": "Specifies the display name of the object. This parameter sets the DisplayName property of the object. The LDAP Display Name (ldapDisplayName) for this property is displayName.", 
               "title": "DisplayName", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "DisplayName"
          }, 
          "showInAdvancedViewOnly": {
               "__type_requested": "System.Boolean", 
               "required": false, 
               "name": "showInAdvancedViewOnly", 
               "title": "showInAdvancedViewOnly", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "Instance": {
               "__type_requested": "ADOrganizationalUnit", 
               "required": false, 
               "description": "Specifies an instance of an organizational unit object to use as a template for a new organizational unit object.\nYou can use an instance of an existing organizational unit object as a template or you can construct a new organizational unit object by using the Windows PowerShell command line or by using a script.\nMethod 1: Use an existing organizational unit object as a template for a new object. To retrieve an instance of an existing organizational unit object use Get-ADOrganizationalUnit. Then provide this object to the Instance parameter of the New-ADOrganizationalUnit cmdlet to create a new organizational unit object. You can override property values of the new object by setting the appropriate parameters.\nMethod 2: Create a new ADOrganizationalUnit object and set the property values by using the Windows PowerShell command line interface. Then pass this object to the Instance parameter of the New-ADOrganizationalUnit cmdlet to create the new Active Directory organizational unit 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"
          }, 
          "State": {
               "__type_requested": "String", 
               "required": false, 
               "description": "Specifies the user's or Organizational Unit's state or province. This parameter sets the State property of a User or Organizational Unit object. The LDAP display name (ldapDisplayName) of this property is st.", 
               "title": "State", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "State"
          }, 
          "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 object. 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": "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"
          }, 
          "gPLink": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "gPLink", 
               "title": "gPLink", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "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"
          }, 
          "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"
          }, 
          "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. Note: The identifier in parentheses is the LDAP display name for the property. The acceptable values for this parameter are:\u00a0\n\n-- A Distinguished Name\n-- A GUID (objectGUID) \n-- A Security Identifier (objectSid) \n-- A SAM Account Name (sAMAccountName)\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"
          }, 
          "LastKnownParent": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "LastKnownParent", 
               "title": "LastKnownParent", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "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"
          }, 
          "Path": {
               "__type_requested": "String", 
               "required": false, 
               "description": "Specifies the X.500 path of the Organizational Unit (OU) or container where the new object is created.\nIn many cases, a default value will be used for the Path parameter if no value is specified.  The rules for determining the default value are given below.  Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated.\nIn AD DS environments, a default value for Path will be set in the following cases:\n\n-- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive.\n-- If the cmdlet has a default path, this will be used.  For example: in New-ADUser, the Path parameter would default to the Users container.\n-- If none of the previous cases apply, the default value of Path will be set to the default partition or naming context of the target domain.\nIn AD LDS environments, a default value for Path will be set in the following cases:\n\n-- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive.\n-- If the cmdlet has a default path, this will be used.  For example: in New-ADUser, the Path parameter would default to the Users container.\n-- If the target AD LDS instance has a default naming context, the default value of Path will be set to the default naming context.  To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. \n-- If none of the previous cases apply, the Path parameter will not take any default value.\nNote:  The Active Directory Provider cmdlets, such New-Item, Remove-Item, Remove-ItemProperty, Rename-Item and Set-ItemProperty also contain a Path property. However, for the provider cmdlets, the Path parameter identifies the path of the actual object and not the container as with the Active Directory cmdlets.", 
               "title": "Path", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Path"
          }, 
          "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"
          }, 
          "Country": {
               "__type_requested": "String", 
               "required": false, 
               "description": "Specifies the country or region code for the user's language of choice. This parameter sets the Country property of a user object. The LDAP Display Name (ldapDisplayName) of this property is c. This value is not used by Windows 2000.", 
               "title": "Country", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Country"
          }, 
          "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"
          }, 
          "StreetAddress": {
               "__type_requested": "String", 
               "required": false, 
               "description": "Specifies the organizational unit's street address. This parameter sets the StreetAddress property of a organizational unit object. The LDAP display name (ldapDisplayName) of this property is street.", 
               "title": "StreetAddress", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "StreetAddress"
          }, 
          "createTimeStamp": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "createTimeStamp", 
               "title": "createTimeStamp", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "PostalCode": {
               "__type_requested": "String", 
               "required": false, 
               "description": "Specifies the user's postal code or zip code. This parameter sets the PostalCode property of a user. The LDAP Display Name (ldapDisplayName) of this property is postalCode.", 
               "title": "PostalCode", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "PostalCode"
          }, 
          "whenChanged": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "whenChanged", 
               "title": "whenChanged", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "msExchEdgeSyncConfigFlags": {
               "__type_requested": "System.Int32", 
               "required": false, 
               "name": "msExchEdgeSyncConfigFlags", 
               "title": "msExchEdgeSyncConfigFlags", 
               "__type_mapping_type": "Integer", 
               "readonly": true, 
               "type": "integer"
          }, 
          "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"
          }, 
          "LinkedGroupPolicyObjects": {
               "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", 
               "required": false, 
               "name": "LinkedGroupPolicyObjects", 
               "title": "LinkedGroupPolicyObjects", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": true, 
               "type": "array"
          }, 
          "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"
          }, 
          "msExchVersion": {
               "__type_requested": "System.Int64", 
               "required": false, 
               "name": "msExchVersion", 
               "title": "msExchVersion", 
               "__type_mapping_type": "Integer", 
               "readonly": true, 
               "type": "integer"
          }, 
          "ou": {
               "__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection", 
               "required": false, 
               "name": "ou", 
               "title": "ou", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": true, 
               "type": "array"
          }, 
          "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/ADOrganizationalUnit/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/activedirectoryhybrid/ADOrganizationalUnit 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/ADOrganizationalUnit/	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/ADOrganizationalUnit/	hierarchy=[hierarchy]	{"hrefs":["/api/device/activedirectoryhybrid/ADOrganizationalUnit/[pkid1]", "/api/device/activedirectoryhybrid/ADOrganizationalUnit/[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/ADOrganizationalUnit
```
GET http://[host-proxy]/api/device/activedirectoryhybrid/ADOrganizationalUnit/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/activedirectoryhybrid/ADOrganizationalUnit/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/ADOrganizationalUnit device/activedirectoryhybrid/ADOrganizationalUnit schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/activedirectoryhybrid/ADOrganizationalUnit/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/activedirectoryhybrid/ADOrganizationalUnit/[pkid1]", "/api/v0/device/activedirectoryhybrid/ADOrganizationalUnit/[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/ADOrganizationalUnit/?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/ADOrganizationalUnit	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/activedirectoryhybrid/ADOrganizationalUnit/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/activedirectoryhybrid/ADOrganizationalUnit	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/activedirectoryhybrid/ADOrganizationalUnit/[pkid1]", "/api/device/activedirectoryhybrid/ADOrganizationalUnit/[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/ADOrganizationalUnit/?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/ADOrganizationalUnit; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/activedirectoryhybrid/ADOrganizationalUnit/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/activedirectoryhybrid/ADOrganizationalUnit/[pkid1]", "/api/device/activedirectoryhybrid/ADOrganizationalUnit/[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/ADOrganizationalUnit and the JSON format can be used to import instances of device/activedirectoryhybrid/ADOrganizationalUnit.

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

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

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

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/activedirectoryhybrid/ADOrganizationalUnit/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/ADOrganizationalUnit/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/ADOrganizationalUnit/	hierarchy=[hierarchy] format=json schema=true	The device/activedirectoryhybrid/ADOrganizationalUnit schema and all instances as JSON.

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

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

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "DisplayName", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/activedirectoryhybrid/ADOrganizationalUnit/?skip=0&limit=3&order_by=DisplayName&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/ADOrganizationalUnit/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/activedirectoryhybrid/ADOrganizationalUnit/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/activedirectoryhybrid/ADOrganizationalUnit/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/ADOrganizationalUnit", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/activedirectoryhybrid/ADOrganizationalUnit/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/ADOrganizationalUnit/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/activedirectoryhybrid/ADOrganizationalUnit/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/activedirectoryhybrid/ADOrganizationalUnit/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/activedirectoryhybrid/ADOrganizationalUnit/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/activedirectoryhybrid/ADOrganizationalUnit/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/activedirectoryhybrid/ADOrganizationalUnit/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/activedirectoryhybrid/ADOrganizationalUnit", 
          "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": "DisplayName", 
                    "title": "DisplayName"
               }, 
               {
                    "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/ADOrganizationalUnit.	GET	/api/device/activedirectoryhybrid/ADOrganizationalUnit/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/activedirectoryhybrid/ADOrganizationalUnit 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/ADOrganizationalUnit/[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/ADOrganizationalUnit/[pkid]/	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/activedirectoryhybrid/ADOrganizationalUnit/[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/ADOrganizationalUnit

GET http://[host-proxy]/api/device/activedirectoryhybrid/ADOrganizationalUnit/?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/ADOrganizationalUnit	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/ADOrganizationalUnit; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/activedirectoryhybrid/ADOrganizationalUnit/[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/ADOrganizationalUnit/[pkid]/	hierarchy=[hierarchy]	The device/activedirectoryhybrid/ADOrganizationalUnit instance with [pkid].

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

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

API Reference for device/activedirectoryhybrid/ADOrganizationalUnit

GET http://[host-proxy]/api/device/activedirectoryhybrid/ADOrganizationalUnit/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/ADOrganizationalUnit/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Purge