API Reference for device/skypeforbusinesshybrid/CsExUmContact

Model ref.: device/skypeforbusinesshybrid/CsExUmContact

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

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "DistinguishedName": {
               "__type_requested": "string", 
               "required": false, 
               "name": "DistinguishedName", 
               "title": "DistinguishedName", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "DisplayName": {
               "__type_requested": "string", 
               "required": false, 
               "name": "DisplayName", 
               "title": "DisplayName", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "TargetServerIfMoving": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Core.ADObjectId", 
               "required": false, 
               "name": "TargetServerIfMoving", 
               "title": "TargetServerIfMoving", 
               "__type_mapping_type": "AutoForeignReference", 
               "readonly": true, 
               "type": "string"
          }, 
          "HostingProvider": {
               "__type_requested": "string", 
               "required": false, 
               "name": "HostingProvider", 
               "title": "HostingProvider", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "UserServicesPolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "UserServicesPolicy", 
               "title": "UserServicesPolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "UserRoutingGroupId": {
               "__type_requested": "guid", 
               "required": false, 
               "name": "UserRoutingGroupId", 
               "title": "UserRoutingGroupId", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "TenantId": {
               "__type_requested": "guid", 
               "required": false, 
               "name": "TenantId", 
               "title": "TenantId", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "LineURI": {
               "__type_requested": "string", 
               "required": false, 
               "name": "LineURI", 
               "title": "LineURI", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "DisplayNumber": {
               "__type_requested": "String", 
               "required": true, 
               "description": "The telephone number of the contact. Display numbers for each contact must be unique (for instance, no two Exchange UM contacts can have the same display number).\nThis value may begin with a plus sign (+) and may contain any number of digits. The first digit cannot be zero.", 
               "title": "DisplayNumber", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "DisplayNumber"
          }, 
          "OtherIpPhone": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty[string]", 
               "required": false, 
               "name": "OtherIpPhone", 
               "title": "OtherIpPhone", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": true, 
               "type": "array"
          }, 
          "LocationPolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "LocationPolicy", 
               "title": "LocationPolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "ExternalAccessPolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "ExternalAccessPolicy", 
               "title": "ExternalAccessPolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "Description": {
               "__type_requested": "String", 
               "required": false, 
               "description": "A description of this contact. The description is for use by administrators to identify the type of contact (Auto Attendant or Subscriber Access), the location, provider, or any other information that will identify the purpose of each Exchange UM contact.", 
               "title": "Description", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Description"
          }, 
          "EnterpriseVoiceEnabled": {
               "__type_requested": "bool", 
               "required": false, 
               "name": "EnterpriseVoiceEnabled", 
               "title": "EnterpriseVoiceEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean", 
               "description": "Indicates whether the contact has been enabled for Enterprise Voice. If this value is set to False, the Auto Attendant or Subscriber Access feature associated with this contact will no longer be available."
          }, 
          "ObjectClass": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty[string]", 
               "required": false, 
               "name": "ObjectClass", 
               "title": "ObjectClass", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": true, 
               "type": "array"
          }, 
          "ClientVersionPolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "ClientVersionPolicy", 
               "title": "ClientVersionPolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "EnabledForRichPresence": {
               "__type_requested": "bool", 
               "required": false, 
               "name": "EnabledForRichPresence", 
               "title": "EnabledForRichPresence", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "VoicePolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "VoicePolicy", 
               "title": "VoicePolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "PinPolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "PinPolicy", 
               "title": "PinPolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "ObjectState": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Interface.ObjectState", 
               "required": false, 
               "name": "ObjectState", 
               "title": "ObjectState", 
               "__type_mapping_type": "Integer", 
               "readonly": true, 
               "type": "integer"
          }, 
          "ThirdPartyVideoSystemPolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "ThirdPartyVideoSystemPolicy", 
               "title": "ThirdPartyVideoSystemPolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "SipAddress": {
               "__type_requested": "String", 
               "required": true, 
               "description": "The SIP address of the contact. This must be a new address that does not already exist as a user or contact in Active Directory Domain Services. This value must begin with the string sip: followed by the SIP address.", 
               "title": "SipAddress", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "SipAddress"
          }, 
          "PersistentChatPolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "PersistentChatPolicy", 
               "title": "PersistentChatPolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "ConferencingPolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "ConferencingPolicy", 
               "title": "ConferencingPolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "EnabledForInternetAccess": {
               "__type_requested": "bool", 
               "required": false, 
               "name": "EnabledForInternetAccess", 
               "title": "EnabledForInternetAccess", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "ArchivingPolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "ArchivingPolicy", 
               "title": "ArchivingPolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "VoiceRoutingPolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "VoiceRoutingPolicy", 
               "title": "VoiceRoutingPolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "OriginatingServer": {
               "__type_requested": "string", 
               "required": false, 
               "name": "OriginatingServer", 
               "title": "OriginatingServer", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "Name": {
               "__type_requested": "string", 
               "required": false, 
               "name": "Name", 
               "title": "Name", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "ObjectId": {
               "__type_requested": "guid", 
               "required": false, 
               "name": "ObjectId", 
               "title": "ObjectId", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "EnabledForFederation": {
               "__type_requested": "bool", 
               "required": false, 
               "name": "EnabledForFederation", 
               "title": "EnabledForFederation", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "Enabled": {
               "__type_requested": "bool", 
               "required": false, 
               "name": "Enabled", 
               "title": "Enabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean", 
               "description": "Indicates whether or not the contact has been enabled for Skype for Business Server 2015. Setting this parameter to False will disable the contact, and the Auto Attendant or Subscriber Access associated with this contact will no longer function.\nIf you disable an account by using the Enabled parameter, the information associated with that account (including assigned hosted voice mail policies) is retained. If you later re-enable the account using the Enable parameter, the associated account information will be restored."
          }, 
          "ExperiencePolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "ExperiencePolicy", 
               "title": "ExperiencePolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "ExchangeArchivingPolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Core.ExchangeArchivingPolicyOptionsEnum", 
               "required": false, 
               "name": "ExchangeArchivingPolicy", 
               "title": "ExchangeArchivingPolicy", 
               "__type_mapping_type": "Complex.ExchangeArchivingPolicy", 
               "choices": [
                    [
                         "0", 
                         "Uninitialized"
                    ], 
                    [
                         "1", 
                         "Use Lync Archiving Policy"
                    ], 
                    [
                         "2", 
                         "Archiving To Exchange"
                    ], 
                    [
                         "3", 
                         "No Archiving"
                    ]
               ], 
               "readonly": true, 
               "type": "integer", 
               "description": "Indicates where the contact's instant messaging sessions are archived. Allowed values are:\nUninitialized\nUseLyncArchivingPolicy\nArchivingToExchange\nNoArchiving"
          }, 
          "IsSubscriberAccess": {
               "__type_requested": "bool", 
               "required": false, 
               "name": "IsSubscriberAccess", 
               "title": "IsSubscriberAccess", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "WhenCreated": {
               "__type_requested": "datetime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenCreated", 
               "title": "WhenCreated", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "AutoAttendant": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "Specifies whether this contact object is an Auto Attendant. (Auto Attendant provides a set of voice prompts that allow callers to navigate the phone system and reach the intended party.)\nDefault: False", 
               "title": "AutoAttendant", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "AutoAttendant"
          }, 
          "TargetRegistrarPool": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "TargetRegistrarPool", 
               "title": "TargetRegistrarPool", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "DialPlan": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "DialPlan", 
               "title": "DialPlan", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "RegistrarPool": {
               "__type_requested": "Fqdn", 
               "required": true, 
               "description": "The fully qualified domain name (FQDN) of the pool on which the Registrar service is running.\nNote that an Exchange UM contact in Skype for Business Server 2015 cannot be moved to pools that are part of Microsoft Office Communications Server 2007 or Microsoft Office Communications Server 2007 R2 deployments.\nFull data type: Microsoft.Rtc.Management.Deploy.Fqdn", 
               "title": "RegistrarPool", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "RegistrarPool"
          }, 
          "IsByPassValidation": {
               "__type_requested": "bool", 
               "required": false, 
               "name": "IsByPassValidation", 
               "title": "IsByPassValidation", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "AddressBookPolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "AddressBookPolicy", 
               "title": "AddressBookPolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "ClientPolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "ClientPolicy", 
               "title": "ClientPolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "HostedVoicemailPolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "HostedVoicemailPolicy", 
               "title": "HostedVoicemailPolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "PublicNetworkEnabled": {
               "__type_requested": "bool", 
               "required": false, 
               "name": "PublicNetworkEnabled", 
               "title": "PublicNetworkEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "ObjectCategory": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Core.ADObjectId", 
               "required": false, 
               "name": "ObjectCategory", 
               "title": "ObjectCategory", 
               "__type_mapping_type": "AutoForeignReference", 
               "readonly": true, 
               "type": "string"
          }, 
          "WhenChanged": {
               "__type_requested": "datetime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenChanged", 
               "title": "WhenChanged", 
               "format": "date-time", 
               "required": false, 
               "readonly": true, 
               "type": "string"
          }, 
          "PresencePolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "PresencePolicy", 
               "title": "PresencePolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "GraphPolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "GraphPolicy", 
               "title": "GraphPolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "ProxyAddresses": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty[string]", 
               "required": false, 
               "name": "ProxyAddresses", 
               "title": "ProxyAddresses", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": true, 
               "type": "array"
          }, 
          "MobilityPolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "MobilityPolicy", 
               "title": "MobilityPolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "Identity": {
               "__type_requested": "UserIdParameter", 
               "required": false, 
               "description": "The unique identifier of the contact object you want to retrieve. Contact identities can be specified using one of four formats: 1) the contact's SIP address; 2) the contact's user principal name (UPN); 3) the contact's domain name and logon name, in the form domain\\logon (for example, litwareinc\\exum1); and, 4) the contact's Active Directory display name (for example, Team Auto Attendant).\nFull data type: Microsoft.Rtc.Management.AD.UserIdParameter", 
               "title": "Identity", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "Identity"
          }, 
          "IsValid": {
               "__type_requested": "bool", 
               "required": false, 
               "name": "IsValid", 
               "title": "IsValid", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "OU": {
               "__type_requested": "OUIdParameter", 
               "required": true, 
               "description": "The organizational unit (OU) where this contact will be located in Active Directory.\nFull data type: Microsoft.Rtc.Management.AD.OUIdParameter", 
               "title": "OU", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "OU"
          }, 
          "Guid": {
               "__type_requested": "guid", 
               "required": false, 
               "name": "Guid", 
               "title": "Guid", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "CallViaWorkPolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "CallViaWorkPolicy", 
               "title": "CallViaWorkPolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "LegalInterceptPolicy": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Collections.UserPolicy", 
               "required": false, 
               "name": "LegalInterceptPolicy", 
               "title": "LegalInterceptPolicy", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "HomeServer": {
               "__type_requested": "Microsoft.Rtc.Management.ADConnect.Core.ADObjectId", 
               "required": false, 
               "name": "HomeServer", 
               "title": "HomeServer", 
               "__type_mapping_type": "AutoForeignReference", 
               "readonly": true, 
               "type": "string"
          }, 
          "ExUmEnabled": {
               "__type_requested": "bool", 
               "required": false, 
               "name": "ExUmEnabled", 
               "title": "ExUmEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }
     }, 
     "schema_version": "1150"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/skypeforbusinesshybrid/CsExUmContact/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/skypeforbusinesshybrid/CsExUmContact 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/skypeforbusinesshybrid/CsExUmContact/	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/skypeforbusinesshybrid/CsExUmContact/	hierarchy=[hierarchy]	{"hrefs":["/api/device/skypeforbusinesshybrid/CsExUmContact/[pkid1]", "/api/device/skypeforbusinesshybrid/CsExUmContact/[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/skypeforbusinesshybrid/CsExUmContact
```
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsExUmContact/?hierarchy=[hierarchy]&format=json
```

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

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

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

 GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsExUmContact/?hierarchy=[hierarchy]

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

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

(The list will return 0 to 3 device/skypeforbusinesshybrid/CsExUmContact instances)

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

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "Description", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/skypeforbusinesshybrid/CsExUmContact/?skip=0&limit=3&order_by=Description&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "meta": {
          "tags": [], 
          "cached": true, 
          "title": "", 
          "business_key": {}, 
          "schema_version": "1150", 
          "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/skypeforbusinesshybrid/CsExUmContact/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/skypeforbusinesshybrid/CsExUmContact/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/skypeforbusinesshybrid/CsExUmContact/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/skypeforbusinesshybrid/CsExUmContact", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/skypeforbusinesshybrid/CsExUmContact/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/skypeforbusinesshybrid/CsExUmContact/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/skypeforbusinesshybrid/CsExUmContact/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/skypeforbusinesshybrid/CsExUmContact/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/skypeforbusinesshybrid/CsExUmContact/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/skypeforbusinesshybrid/CsExUmContact/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/skypeforbusinesshybrid/CsExUmContact/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/skypeforbusinesshybrid/CsExUmContact", 
          "model_specific_actions": [
               "get", 
               "list", 
               "powershell_move", 
               "add", 
               "remove", 
               "update", 
               "bulk_update_form", 
               "clone", 
               "configuration_template", 
               "export", 
               "export_bulkload_template", 
               "field_display_policy", 
               "help", 
               "move"
          ], 
          "summary_attrs": [
               {
                    "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/skypeforbusinesshybrid/CsExUmContact.	GET	/api/device/skypeforbusinesshybrid/CsExUmContact/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/skypeforbusinesshybrid/CsExUmContact 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/skypeforbusinesshybrid/CsExUmContact/[pkid]/	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/device/skypeforbusinesshybrid/CsExUmContact/[pkid]/	hierarchy=[hierarchy]

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

GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsExUmContact/?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/skypeforbusinesshybrid/CsExUmContact	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/skypeforbusinesshybrid/CsExUmContact; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/skypeforbusinesshybrid/CsExUmContact/[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

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

For Bulk Export, refer to the Bulk Export section.

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

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

Task	Call	URL	Parameters	Payload
Powershell Move	POST	/api/device/skypeforbusinesshybrid/CsExUmContact/[pkid]/+powershell_move/	hierarchy=[hierarchy]	If payload required:

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

API Reference for device/skypeforbusinesshybrid/CsExUmContact

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

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Powershell Move

Purge