[Index]

API Reference for data/MSDefaults

Microsoft Defaults ------------------ The Lync/Microsoft Default settings provide a mechanism for ensuring that the Quick Add Subscriber and Subscriber Management automation templates apply the settings that are appropriate for a specific environment (i.e. site or customer). When adding a subscriber using the Quick Add Subscriber automation template the Quick Add Groups are applied once the Lync/Microsoft details are applied. More particularly the settings that are applied to Microsoft Lync / Skype for Business users can be defined: * By Lync/Microsoft Defaults instances at a higher level of the VOSS hierarchy (e.g. customer) level, * Overridden(1) with Lync/Microsoft Defaults instances at a lower (e.g. country, site, department, etc depending on how the hierarchy has been configured) level, or * Overridden(1) by Quick Add Groups selected in Quick Add Subscriber templates. **(1) Overridden**: When a policy is defined in the Lync/Microsoft Defaults it will be overwritten if defined in an instance at site level or in the Quick add groups. **NOTE**: This mechanism will be referred to as the policy applicable to the user or just applicable policy. Default Lync / Skype for Business Polices ----------------------------------------- VOSS can be used to configure the following Lync/Skype for Business policies based on the business hierarchy of the user. **Enterprise Voice Configuration:** * Dialplan * Voice Policy **Advanced Policies:** * Conferencing Policy * Persistent Chat Policy * Mobility Policy * External Access Policy * Client Version Policy * PIN Policy * Location Policy * Archiving Policy * Client Policy Default Voicemail Policies -------------------------- Quick Add Subscriber operations with the Voicemail option selected operate as follows: * When 'Exchange UM for Voicemail' is checked * An Exhange Mailbox is created if it does not exist and * The Exchange Mailbox is enabled for Unified Messaging (UM) using the Skype for Business Line URI provided it is not already enabled. * Otherwise Cisco Unity Connection is used for voicemail in a multi-vendor solution. **NOTE**: The user will only see Voicemail in the Quick Add Subscriber user interface and the defaults will define whether Unity Connect mailbox or Exchange UM is provisioned. The default Exchange UM Mailbox Policy used when enabling Exchange UM can be specified unless overridden by Quick Add Groups. Extension Length ---------------- The |VOSS-4-UC| Number Inventory can be used to manage Direct Inward Dialling Numbers (DIDs) and/or Extension Numbers. Numbers in the Number Inventory that start with a '+' are considered DIDs. Features that make use of the |VOSS-4-UC| Number Inventory selector can derive the Extension at the selected site from the selected DID using the **Extension Length** configured by the Microsoft Defaults of the site. |VOSS-4-UC| supports Extension Lengths between 3 to 7 digits. Using Extension Length in Microsoft Defaults to derive Extension Numbers from DID numbers ----------------------------------------------------------------------------------------- When editing Microsoft Lync / Skype for Business LineURI of users or other features such as Conference Dial-in Access Numbers the **Extension Length** setting in **Microsoft defaults** in is handled as follows: * When user selects an Extension from the |VOSS-4-UC| Number Inventory the LineURI is set to **tel:+<EXT>;ext=<EXT>** * When he user selects a DID from the |VOSS-4-UC| Number Inventory the LineURI is set to **tel:<DID>;ext=<Last 'Extension Length' digits of the DID>** * When does not change anything or enters the LineURI according to the Microsoft Lync / Skype for Business format (i.e. starting with 'T' or 't') no further processing of the LineURI will take place. This allows control of * the users DID (e.g. **tel:+27215252020;Ext=2020**) as the user's E164 phone number or, * the Operator Number (also called PSTN published number) as the user's E164 phone number. **Examples**: * A user with a LineURI of **tel:+27215252020;Ext=2020** has been assigned a DID of +27215252020 and an Extension Number 2020. * A user with a LineURI of **tel:+27215252000;Ext=2020** has been assigned Extension Number 2020 while the switchboard operator's number +27215252000 will be presented as the user's caller ID when the user makes PSTN phone calls. * A user with a LineURI of **tel:+27215252025** has been assigned DID of +27215252025. Updating the |VOSS-4-UC| Number Inventory ----------------------------------------- When DIDs and/or Extension Numbers selected as the LineURI, Phone Number or Extension are stored in the |VOSS-4-UC| Number Inventory the status (used and/or available) of the Extension Numbers and/or DID numbers will be updated accordingly. .. |VOSS-4-UC| replace:: VOSS-4-UC

Model ref.: data/MSDefaults

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

Variables are enclosed in square brackets.

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

Get the Add form

Task Call URL Parameters Response
Get the GUI Add form. GET /api/data/MSDefaults/add/
  • hierarchy=[hierarchy]
  • format=json
 The GUI Add form of data/MSDefaults 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.

Create

Task Call URL Parameters Payload
Create POST /api/data/MSDefaults/ 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.

    • Bulk Delete

    Task Call URL Parameters Payload
    Bulk delete [pkid1],[pkid2]... DELETE /api/data/MSDefaults/ hierarchy=[hierarchy] {"hrefs":["/api/data/MSDefaults/[pkid1]", "/api/data/MSDefaults/[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: data/MSDefaults 
      GET http://[host-proxy]/api/data/MSDefaults/?hierarchy=[hierarchy]&format=json

    Move

    Task Call URL Parameters Payload
    Move the instance with [pkid] to [target_hierarchy] POST /api/tool/DataMove/?model_type=data/MSDefaults
    • hierarchy=[hierarchy]
    • context_hierarchy=[target_hierarchy]
    • format=json
    • (nowait=true)
    		 {"hrefs": ["/api/data/MSDefaults/[pkid]"]}
    Bulk Move POST /api/tool/DataMove/?model_type=data/MSDefaults
    • hierarchy==[hierarchy]
    • context_hierarchy=[target_hierarchy]
    • format=json
    • (nowait=true)
    		 {"hrefs": ["/api/data/MSDefaults/[pkid1]", "/api/data/MSDefaults/[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/data/MSDefaults/?hierarchy=[hierarchy]&format=json&schema_rules=true

    Bulk Export

    Task Call URL Parameters Payload
    Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/MSDefaults; optionally with tag_version at [version] and Configuration Template as [configtemplate]. POST /api/data/MSDefaults/export/
    • hierarchy=[hierarchy]
    • version=[version]
    • schema=
    • schema_rules=
    • template_name=[configtemplate]
    • export_format=[raw_xlsx|xlsx|json]
    		 { "hrefs":["/api/data/MSDefaults/[pkid1]", "/api/data/MSDefaults/[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 data/MSDefaults and the JSON format can be used to import instances of data/MSDefaults.

    • To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for data/MSDefaults: 
    •  GET http://[host-proxy]/api/data/MSDefaults/?hierarchy=[hierarchy]

    Configuration Template

    Task Call URL Parameters Response
    Configuration Template GET /api/data/MSDefaults/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]

    Field Display Policy

    Task Call URL Parameters Response
    Field Display Policy GET /api/data/MSDefaults/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]

    Migration Template

    Task Call URL Parameters Response
    Migration Template GET /api/data/MSDefaults/migration/
    • hierarchy=[hierarchy]
    • format=json
    		  

    List

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

    (The list will return 0 to 3 data/MSDefaults instances)

    Help

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

    Instance API Reference

    Modify

    Task Call URL Parameters Payload
    Modify PUT /api/data/MSDefaults/[pkid]/ hierarchy=[hierarchy] (For payload specification)

    For Bulk modification, refer to the Bulk Modify section.

    Delete

    Task Call URL Parameters Response
    Delete DELETE /api/data/MSDefaults/[pkid]/ hierarchy=[hierarchy]

    Clone

    Task Call URL Parameters Response
    Clone instance with [pkid]. The schema rules are applied. GET /api/data/MSDefaults/[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 data/MSDefaults
    • GET http://[host-proxy]/api/data/MSDefaults/?hierarchy=[hierarchy]&format=json
    • Use the POST action in the response with a modification of the response payload to create the clone.

    Move

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

    Export

    Task Call URL Parameters Response
    Get a selected [export_format] of the schema and a single instance with [pkid] of data/MSDefaults; optionally with tag_version at [version] and Configuration Template as [configtemplate]. GET /api/data/MSDefaults/[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 data/MSDefaults and the JSON format can be used to import instances of data/MSDefaults.

    For Bulk Export, refer to the Bulk Export section.

    Tag

    Task Call URL Parameters Payload
    Tag PATCH /api/data/MSDefaults/[pkid]/+tag/ hierarchy=[hierarchy] If payload required:

    Get

    Task Call URL Parameters Response
    Get GET /api/data/MSDefaults/[pkid]/ hierarchy=[hierarchy] The data/MSDefaults instance with [pkid].

    Help

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