[Index]
Microsoft Subscriber Qas Staging Relation
Model ref.: relation/MicrosoftSubscriberQasStaging
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": {
"username": {
"required": true,
"type": "string",
"description": "Username of User",
"title": "Username"
},
"first_name": {
"type": "string",
"title": "First name"
},
"last_name": {
"type": "string",
"title": "Last name"
},
"email": {
"type": "string",
"title": "Email address"
},
"send_email": {
"type": "boolean",
"description": "Send Email to user using predefined HTML Email Template. Email template used is 'Quick Add Subscriber'. To enable email feature set 'Allow welcome email to be sent to user after Quick Add Subscriber' in Global Settings.",
"title": "Send welcome email"
},
"feature_type": {
"type": "string",
"title": "Feature type"
},
"automatic_line": {
"type": "boolean",
"title": "Use next available line"
},
"line_uri": {
"type": "string",
"title": "Line URI"
},
"line_uri_type": {
"type": "string",
"title": "Line URI type"
},
"calling_line_identity": {
"type": "string",
"title": "Calling line identity"
},
"online_voice_routing_policy": {
"type": "string",
"title": "Online voice routing policy"
},
"tenant_dial_plan": {
"type": "string",
"title": "Tenant dial plan"
},
"custom_string_1": {
"type": "string",
"description": "Custom String",
"title": "Custom String 1"
},
"custom_string_2": {
"type": "string",
"description": "Custom String",
"title": "Custom String 2"
},
"custom_string_3": {
"type": "string",
"description": "Custom String",
"title": "Custom String 3"
},
"custom_string_4": {
"type": "string",
"description": "Custom String",
"title": "Custom String 4"
},
"custom_string_5": {
"type": "string",
"description": "Custom String",
"title": "Custom String 5"
},
"custom_string_6": {
"type": "string",
"description": "Custom String",
"title": "Custom String 6"
},
"custom_string_7": {
"type": "string",
"description": "Custom String",
"title": "Custom String 7"
},
"custom_string_8": {
"type": "string",
"description": "Custom String",
"title": "Custom String 8"
},
"custom_string_9": {
"type": "string",
"description": "Custom String",
"title": "Custom String 9"
},
"custom_string_10": {
"type": "string",
"description": "Custom String",
"title": "Custom String 10"
},
"custom_boolean_1": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 1"
},
"custom_boolean_2": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 2"
},
"custom_boolean_3": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 3"
},
"custom_boolean_4": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 4"
},
"custom_boolean_5": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 5"
},
"custom_boolean_6": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 6"
},
"custom_boolean_7": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 7"
},
"custom_boolean_8": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 8"
},
"custom_boolean_9": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 9"
},
"custom_boolean_10": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 10"
},
"qagroup_name": {
"type": "string",
"title": "Quick Add Group"
},
"timestamp": {
"type": "string",
"title": "Timestamp"
},
"status": {
"type": "string",
"title": "Staging Status"
},
"MicrosoftSubscriberQasStaging": {
"title": "Microsoft Subscriber Qas Staging",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"maxItems": 1
}
},
"schema_version": "0.1"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/MicrosoftSubscriberQasStaging/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/MicrosoftSubscriberQasStaging/[pkid1]", "/api/relation/MicrosoftSubscriberQasStaging/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/MicrosoftSubscriberQasStaging/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/MicrosoftSubscriberQasStaging |
|
{"hrefs": ["/api/relation/MicrosoftSubscriberQasStaging/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/MicrosoftSubscriberQasStaging |
|
{"hrefs": ["/api/relation/MicrosoftSubscriberQasStaging/[pkid1]", "/api/relation/MicrosoftSubscriberQasStaging/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/MicrosoftSubscriberQasStaging; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/MicrosoftSubscriberQasStaging/export/ |
|
{ "hrefs":["/api/relation/MicrosoftSubscriberQasStaging/[pkid1]", "/api/relation/MicrosoftSubscriberQasStaging/[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 relation/MicrosoftSubscriberQasStaging and the JSON format can be used to import instances of relation/MicrosoftSubscriberQasStaging.
GET http://[host-proxy]/api/relation/MicrosoftSubscriberQasStaging/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/MicrosoftSubscriberQasStaging | POST | /api/relation/MicrosoftSubscriberQasStaging/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/MicrosoftSubscriberQasStaging/ |
|
The relation/MicrosoftSubscriberQasStaging schema and all instances as JSON. |
(The list will return 0 to 3 relation/MicrosoftSubscriberQasStaging instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "username",
"direction": "asc",
"current": "/api/relation/MicrosoftSubscriberQasStaging/?skip=0&limit=3&order_by=username&direction=asc&traversal=down"
},
"operations": [
"list",
"help",
"field_display_policy",
"get",
"configuration_template",
"update",
"bulk_update",
"remove",
"add",
"export",
"export_bulkload_template",
"move"
],
"meta": {
"model_type": "relation/MicrosoftSubscriberQasStaging",
"summary_attrs": [
{
"name": "username",
"title": "Username"
},
{
"name": "first_name",
"title": "First name"
},
{
"name": "last_name",
"title": "Last name"
},
{
"name": "send_email",
"title": "Send welcome email"
},
{
"name": "line_uri",
"title": "Line URI"
},
{
"name": "calling_line_identity",
"title": "Calling line identity"
},
{
"name": "online_voice_routing_policy",
"title": "Online voice routing policy"
},
{
"name": "qagroup_name",
"title": "Quick Add Group"
},
{
"name": "timestamp",
"title": "Timestamp"
},
{
"name": "status",
"title": "Staging Status"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/MicrosoftSubscriberQasStaging/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"list",
"help",
"get",
"update",
"remove",
"add",
"export",
"export_bulkload_template",
"move"
],
"schema_version": "0.1",
"actions": [
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/MicrosoftSubscriberQasStaging/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/MicrosoftSubscriberQasStaging",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/MicrosoftSubscriberQasStaging/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/MicrosoftSubscriberQasStaging/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/MicrosoftSubscriberQasStaging/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/MicrosoftSubscriberQasStaging/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/MicrosoftSubscriberQasStaging. | GET | /api/relation/MicrosoftSubscriberQasStaging/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/MicrosoftSubscriberQasStaging as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/MicrosoftSubscriberQasStaging/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/MicrosoftSubscriberQasStaging/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/MicrosoftSubscriberQasStaging | 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 relation/MicrosoftSubscriberQasStaging; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/MicrosoftSubscriberQasStaging/[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 relation/MicrosoftSubscriberQasStaging and the JSON format can be used to import instances of relation/MicrosoftSubscriberQasStaging.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/MicrosoftSubscriberQasStaging/[pkid] | hierarchy=[hierarchy] | The relation/MicrosoftSubscriberQasStaging instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/MicrosoftSubscriberQasStaging/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/MicrosoftSubscriberQasStaging. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Unstage Immediate | POST | /api/relation/MicrosoftSubscriberQasStaging/[pkid]/+UnstageImmediate | hierarchy=[hierarchy] | If payload required: |