[Index]
Model ref.: device/activedirectoryhybrid/ADGroup
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": {
"msExchGroupJoinRestriction": {
"__type_requested": "System.Int32",
"required": false,
"name": "msExchGroupJoinRestriction",
"title": "msExchGroupJoinRestriction",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"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"
},
"msExchRecipientTypeDetails": {
"__type_requested": "System.Int64",
"required": false,
"name": "msExchRecipientTypeDetails",
"title": "msExchRecipientTypeDetails",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"MemberOf": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"name": "MemberOf",
"title": "MemberOf",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": true,
"type": "array"
},
"adminCount": {
"__type_requested": "System.Int32",
"required": false,
"name": "adminCount",
"title": "adminCount",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"Instance": {
"__type_requested": "ADGroup",
"required": false,
"description": "Specifies an instance of a group object to use as a template for a new group object.\nYou can use an instance of an existing group object as a template or you can construct a new group object by using the Windows PowerShell command line or by using a script.\nMethod 1: Use an existing group object as a template for a new object. Use the Get-ADGroup cmdlet to retrieve a group object then pass this object to the Instance parameter of the New-ADGroup cmdlet to create a new group object. You can override property values of the new object by setting the appropriate parameters.\nMethod 2: Create a new ADGroup 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-ADGroup cmdlet to create the new group 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"
},
"msExchBypassAudit": {
"__type_requested": "System.Boolean",
"required": false,
"name": "msExchBypassAudit",
"title": "msExchBypassAudit",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"SID": {
"__type_requested": "System.Security.Principal.SecurityIdentifier",
"required": false,
"name": "SID",
"title": "SID",
"__type_mapping_type": "Complex.SecurityIdentifier",
"readonly": true,
"type": "object",
"properties": {
"BinaryLength": {
"type": "integer",
"name": "BinaryLength",
"title": "BinaryLength"
},
"Value": {
"type": "string",
"name": "Value",
"title": "Value"
},
"AccountDomainSid": {
"type": "string",
"name": "AccountDomainSid",
"title": "AccountDomainSid"
}
}
},
"internetEncoding": {
"__type_requested": "System.Int32",
"required": false,
"name": "internetEncoding",
"title": "internetEncoding",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"msExchRoleGroupType": {
"__type_requested": "System.Int32",
"required": false,
"name": "msExchRoleGroupType",
"title": "msExchRoleGroupType",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"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"
},
"GroupCategory": {
"__type_requested": "System.Nullable`1[[Microsoft.ActiveDirectory.Management.ADGroupCategory,",
"required": false,
"description": "Specifies the category of the group. The acceptable values for this parameter are:\u00a0\n\n-- Distribution or 0\n-- Security or 1\nThis parameter sets the GroupCategory property of the group. This parameter value combined with other group values sets the LDAP Display Name (ldapDisplayName) attribute named groupType.",
"title": "GroupCategory",
"__type_mapping_type": "Unknown",
"name": "GroupCategory",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"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"
},
"msExchProvisioningFlags": {
"__type_requested": "System.Int32",
"required": false,
"name": "msExchProvisioningFlags",
"title": "msExchProvisioningFlags",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"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"
},
"objectSid": {
"__type_requested": "System.Security.Principal.SecurityIdentifier",
"required": false,
"name": "objectSid",
"title": "objectSid",
"__type_mapping_type": "Complex.SecurityIdentifier",
"readonly": true,
"type": "object",
"properties": {
"BinaryLength": {
"type": "integer",
"name": "BinaryLength",
"title": "BinaryLength"
},
"Value": {
"type": "string",
"name": "Value",
"title": "Value"
},
"AccountDomainSid": {
"type": "string",
"name": "AccountDomainSid",
"title": "AccountDomainSid"
}
}
},
"member": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"name": "member",
"title": "member",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": true,
"type": "array"
},
"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-- SAM Account Name (sAMAccountName)",
"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"
},
"ObjectClass": {
"__type_requested": "System.String",
"required": false,
"name": "ObjectClass",
"title": "ObjectClass",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"msExchAddressBookFlags": {
"__type_requested": "System.Int32",
"required": false,
"name": "msExchAddressBookFlags",
"title": "msExchAddressBookFlags",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"SIDHistory": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"name": "SIDHistory",
"title": "SIDHistory",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": true,
"type": "array"
},
"Members": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"name": "Members",
"title": "Members",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": true,
"type": "array"
},
"msExchTransportRecipientSettingsFlags": {
"__type_requested": "System.Int32",
"required": false,
"name": "msExchTransportRecipientSettingsFlags",
"title": "msExchTransportRecipientSettingsFlags",
"__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"
},
"HomePage": {
"__type_requested": "String",
"required": false,
"description": "Specifies the URL of the home page of the object. This parameter sets the homePage property of an Active Directory object. The LDAP Display Name (ldapDisplayName) for this property is wWWHomePage.",
"title": "HomePage",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "HomePage"
},
"msExchUserBL": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"name": "msExchUserBL",
"title": "msExchUserBL",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": true,
"type": "array"
},
"groupType": {
"__type_requested": "System.Int32",
"required": false,
"name": "groupType",
"title": "groupType",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"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"
},
"createTimeStamp": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "createTimeStamp",
"title": "createTimeStamp",
"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"
},
"whenChanged": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "whenChanged",
"title": "whenChanged",
"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"
},
"whenCreated": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "whenCreated",
"title": "whenCreated",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"GroupScope": {
"__type_requested": "System.Nullable`1[[Microsoft.ActiveDirectory.Management.ADGroupScope,",
"required": true,
"description": "Specifies the group scope of the group. The acceptable values for this parameter are:\u00a0\n\n-- DomainLocal or 0\n-- Global or 1\n-- Universal or 2\nThis parameter sets the GroupScope property of a group object to the specified value. The LDAP display name of this property is groupType.",
"title": "GroupScope",
"__type_mapping_type": "Unknown",
"name": "GroupScope",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly 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"
},
"msExchMailboxAuditEnable": {
"__type_requested": "System.Boolean",
"required": false,
"name": "msExchMailboxAuditEnable",
"title": "msExchMailboxAuditEnable",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"msExchLocalizationFlags": {
"__type_requested": "System.Int32",
"required": false,
"name": "msExchLocalizationFlags",
"title": "msExchLocalizationFlags",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"msExchGroupMemberCount": {
"__type_requested": "System.Int32",
"required": false,
"name": "msExchGroupMemberCount",
"title": "msExchGroupMemberCount",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"SamAccountName": {
"__type_requested": "String",
"required": false,
"description": "Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service account. The maximum length of the description is 256 characters. To be compatible with older operating systems, create a SAM account name that is 20 characters or less. This parameter sets the SAMAccountName for an account object. The LDAP display name (ldapDisplayName) for this property is sAMAccountName.\nNote: If the string value provided is not terminated with a $ character, the system adds one if needed.",
"title": "SamAccountName",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "SamAccountName"
},
"ObjectCategory": {
"__type_requested": "System.String",
"required": false,
"name": "ObjectCategory",
"title": "ObjectCategory",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"msExchMailboxAuditLogAgeLimit": {
"__type_requested": "System.Int32",
"required": false,
"name": "msExchMailboxAuditLogAgeLimit",
"title": "msExchMailboxAuditLogAgeLimit",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"uSNCreated": {
"__type_requested": "System.Int64",
"required": false,
"name": "uSNCreated",
"title": "uSNCreated",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"managedObjects": {
"__type_requested": "Microsoft.ActiveDirectory.Management.ADPropertyValueCollection",
"required": false,
"name": "managedObjects",
"title": "managedObjects",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": true,
"type": "array"
},
"DistinguishedName": {
"__type_requested": "System.String",
"required": false,
"name": "DistinguishedName",
"title": "DistinguishedName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"msExchModerationFlags": {
"__type_requested": "System.Int32",
"required": false,
"name": "msExchModerationFlags",
"title": "msExchModerationFlags",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"CanonicalName": {
"__type_requested": "System.String",
"required": false,
"name": "CanonicalName",
"title": "CanonicalName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"msExchRecipientSoftDeletedStatus": {
"__type_requested": "System.Int32",
"required": false,
"name": "msExchRecipientSoftDeletedStatus",
"title": "msExchRecipientSoftDeletedStatus",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"sAMAccountType": {
"__type_requested": "System.Int32",
"required": false,
"name": "sAMAccountType",
"title": "sAMAccountType",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"msExchGroupDepartRestriction": {
"__type_requested": "System.Int32",
"required": false,
"name": "msExchGroupDepartRestriction",
"title": "msExchGroupDepartRestriction",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"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"
},
"msExchGroupExternalMemberCount": {
"__type_requested": "System.Int32",
"required": false,
"name": "msExchGroupExternalMemberCount",
"title": "msExchGroupExternalMemberCount",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"msExchVersion": {
"__type_requested": "System.Int64",
"required": false,
"name": "msExchVersion",
"title": "msExchVersion",
"__type_mapping_type": "Integer",
"readonly": true,
"type": "integer"
},
"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/ADGroup/add/ |
|
The GUI Add form of device/activedirectoryhybrid/ADGroup 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/ADGroup | 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/ADGroup/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/activedirectoryhybrid/ADGroup/[pkid1]", "/api/device/activedirectoryhybrid/ADGroup/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/activedirectoryhybrid/ADGroup/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/activedirectoryhybrid/ADGroup/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/activedirectoryhybrid/ADGroup/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/activedirectoryhybrid/ADGroup/[pkid1]", "/api/v0/device/activedirectoryhybrid/ADGroup/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/activedirectoryhybrid/ADGroup/?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/ADGroup |
|
{"hrefs": ["/api/device/activedirectoryhybrid/ADGroup/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/activedirectoryhybrid/ADGroup |
|
{"hrefs": ["/api/device/activedirectoryhybrid/ADGroup/[pkid1]", "/api/device/activedirectoryhybrid/ADGroup/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/activedirectoryhybrid/ADGroup; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/activedirectoryhybrid/ADGroup/export/ |
|
{ "hrefs":["/api/device/activedirectoryhybrid/ADGroup/[pkid1]", "/api/device/activedirectoryhybrid/ADGroup/[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/ADGroup and the JSON format can be used to import instances of device/activedirectoryhybrid/ADGroup.
GET http://[host-proxy]/api/device/activedirectoryhybrid/ADGroup/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/activedirectoryhybrid/ADGroup | POST | /api/device/activedirectoryhybrid/ADGroup/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/ADGroup/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/ADGroup/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/activedirectoryhybrid/ADGroup/ |
|
The device/activedirectoryhybrid/ADGroup schema and all instances as JSON. |
(The list will return 0 to 3 device/activedirectoryhybrid/ADGroup instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/activedirectoryhybrid/ADGroup/?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/ADGroup/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/activedirectoryhybrid/ADGroup/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/activedirectoryhybrid/ADGroup/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/ADGroup",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/activedirectoryhybrid/ADGroup/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/ADGroup/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/activedirectoryhybrid/ADGroup/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/activedirectoryhybrid/ADGroup/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/activedirectoryhybrid/ADGroup/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/activedirectoryhybrid/ADGroup/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/activedirectoryhybrid/ADGroup/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/activedirectoryhybrid/ADGroup",
"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": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/activedirectoryhybrid/ADGroup. | GET | /api/device/activedirectoryhybrid/ADGroup/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/activedirectoryhybrid/ADGroup as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/activedirectoryhybrid/ADGroup/[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/ADGroup/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/activedirectoryhybrid/ADGroup/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/activedirectoryhybrid/ADGroup/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/activedirectoryhybrid/ADGroup | 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/ADGroup; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/activedirectoryhybrid/ADGroup/[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/ADGroup and the JSON format can be used to import instances of device/activedirectoryhybrid/ADGroup.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/activedirectoryhybrid/ADGroup/[pkid] | hierarchy=[hierarchy] | The device/activedirectoryhybrid/ADGroup instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/activedirectoryhybrid/ADGroup/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/activedirectoryhybrid/ADGroup. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/activedirectoryhybrid/ADGroup/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |