[Index]

API Reference for data/LyncQuickAddGroups

MS Quick Add Groups =================== Microsoft Quick Add Groups -------------------------- The settings defined in the configuration templates (e.g. Skype for Business User) specified in the Quick Add Group are used to determine the configuration of the corresponding service (e.g. the settings of the Skype for Business user). The actual settings provisioned for the user is a combination of the Quick Add Group of the user and the MS defaults for the site as explained below. Whilst Quick Add Groups define the settings for each use type, Lync/Microsoft Default settings ensure that the Quick Add Subscriber automation templates apply settings appropriate to the type of user. When adding a subscriber using the Quick Add Subscriber automation template, the Quick Add Groups are applied once the Lync/Microsoft details are applied. 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 [#f1]_ with Lync/Microsoft Defaults instances at a lower level (e.g. country, site, department, etc depending on how the hierarchy has been configured), or * Specified by Quick Add Groups selected in Quick Add Subscriber templates. Selecting Microsoft Licenses ---------------------------- In order to allocate the correct Office 365 features applicable in the country of the user who is consuming the license, specify the default Usage Location (country) used for the site. If it is not specified, the setting from MS defaults will be used. The Office 365 Licenses allocated to the user during the Quick Add Subscriber on-boarding process is specified by the License settings in the Quick Add Group allocated to the user. The service plans for Skype for Business Online, Exchange Online and other MS online services can be specified in order to ensure that only the necessary service plans are enabled/disabled during migration of Skype for Business and Exchange users or on-boarding of users: * Skype for Business Service Plans enabled in the selected Quick Add Group will be enabled if the user is given Skype for Business Online Services. * Exchange Service Plans enabled in the selected Quick Add Group will be enabled if the user is given an online voicemail box. * Other service plans enabled in the Quick Add Group selected will be enabled if the user is given MS online services. .. |VOSS-4-UC| replace:: VOSS-4-UC .. [#f1] 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.

Model ref.: data/LyncQuickAddGroups

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/LyncQuickAddGroups/add/
  • hierarchy=[hierarchy]
  • format=json
 The GUI Add form of data/LyncQuickAddGroups 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/LyncQuickAddGroups/ 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/LyncQuickAddGroups/ hierarchy=[hierarchy] {"hrefs":["/api/data/LyncQuickAddGroups/[pkid1]", "/api/data/LyncQuickAddGroups/[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/LyncQuickAddGroups 
      GET http://[host-proxy]/api/data/LyncQuickAddGroups/?hierarchy=[hierarchy]&format=json

    Bulk Modify

    Task Call URL Parameters Response
    Bulk Modify GET /api/data/LyncQuickAddGroups/bulk_update/?schema=&schema_rules=true
    • hierarchy=[hierarchy]
    • format=json
    • pkids=pkid1,pkid2,...
      In JSON format:
    • POST call to update the instances of data/LyncQuickAddGroups
    • data/LyncQuickAddGroups schema to create POST payload.
    Task Call URL Parameters Payload
    Bulk Modify POST /api/data/LyncQuickAddGroups/bulk_update/
    • hierarchy=[hierarchy]
    • format=json
    		 For example:
    {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/LyncQuickAddGroups/[pkid1]", "/api/v0/data/LyncQuickAddGroups/[pkid2]",...]}}
    • To get a list of model instance pkids that are available to Bulk Modify, use the GET call:
      GET http://[host-proxy]/api/data/LyncQuickAddGroups/?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

    Bulk Export

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

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

    Export Bulk Load Template

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

    Configuration Template

    Task Call URL Parameters Response
    Configuration Template GET /api/data/LyncQuickAddGroups/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/LyncQuickAddGroups/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/LyncQuickAddGroups/migration/
    • hierarchy=[hierarchy]
    • format=json
    		  

    List

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

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

    Help

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

    Instance API Reference

    Modify

    Task Call URL Parameters Payload
    Modify PUT /api/data/LyncQuickAddGroups/[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/LyncQuickAddGroups/[pkid]/ hierarchy=[hierarchy]

    Clone

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

    Export

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

    For Bulk Export, refer to the Bulk Export section.

    Tag

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

    Get

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

    Help

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