[Index]
Model ref.: device/pexip/Conference
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": { "id": { "readonly": true, "type": "string", "title": "Id" }, "allow_guests": { "required": false, "type": "boolean", "title": "Allow Guests" }, "call_type": { "required": false, "type": "string", "title": "Call Type", "choices": [ { "value": "audio", "title": "Audio-only" }, { "value": "video", "title": "Main video + presentation" }, { "value": "video-only", "title": "Main video only" } ], "default": "video" }, "creation_time": { "required": false, "type": "string", "title": "Creation Time" }, "crypto_mode": { "required": false, "type": "string", "title": "Crypto Mode", "choices": [ { "value": "", "title": "Use global setting" }, { "value": "besteffort", "title": "Best effort" }, { "value": "on", "title": "Required" }, { "value": "off", "title": "No encryption" } ], "default": "" }, "description": { "required": false, "type": "string", "title": "Description" }, "enable_chat": { "required": false, "type": "string", "title": "Enable Chat", "choices": [ { "value": "default", "title": "Use global chat setting" }, { "value": "yes", "title": "Yes" }, { "value": "no", "title": "No" } ], "default": "default" }, "enable_overlay_text": { "required": false, "type": "boolean", "title": "Enable Overlay Text" }, "force_presenter_into_main": { "required": false, "type": "boolean", "title": "Force Presenter Into Main" }, "gms_access_token": { "required": false, "type": "string", "title": "GMS Access Token" }, "guest_pin": { "required": false, "type": "string", "title": "Guest Pin" }, "guest_view": { "required": false, "type": "string", "title": "Guest View" }, "guests_can_present": { "required": false, "type": "boolean", "title": "Guests Can Present" }, "host_view": { "required": false, "type": "string", "title": "Host View", "choices": [ { "value": "one_main_zero_pips", "title": "Full-screen main speaker only (1 + 0 layout)" }, { "value": "four_mains_zero_pips", "title": "4 main speakers only (4 + 0 layout)" }, { "value": "one_main_seven_pips", "title": "Large main speaker and up to 7 other participants (1 + 7 layout)" }, { "value": "one_main_twentyone_pips", "title": "Small main speaker and up to 21 other participants (1 + 21 layout)" }, { "value": "two_mains_twentyone_pips", "title": "2 small main speakers and up to 21 other participants (2 + 21 layout)" } ], "default": "one_main_seven_pips" }, "ivr_theme": { "target": "/api/device/pexip/IvrTheme/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "format": "uri", "convert_to_primary_key": true, "required": false, "type": "string", "title": "IVR Theme", "target_model_type": "device/pexip/IvrTheme", "choices": [] }, "match_string": { "required": false, "type": "string", "title": "Match String" }, "max_callrate_in": { "required": false, "type": "integer", "title": "Max Callrate In" }, "max_callrate_out": { "required": false, "type": "integer", "title": "Max Callrate Out" }, "max_pixels_per_second": { "required": false, "type": "string", "title": "Max Pixels Per Second", "choices": [ { "value": "", "title": "Use global setting" }, { "value": "sd", "title": "SD" }, { "value": "hd", "title": "HD" }, { "value": "fullhd", "title": "Full HD (1080p)" } ] }, "mssip_proxy": { "required": false, "type": "string", "title": "MSSIP Proxy" }, "mute_all_guests": { "required": false, "type": "boolean", "title": "Mute All Guests" }, "name": { "required": true, "type": "string", "title": "Name" }, "participant_limit": { "required": false, "type": "integer", "title": "Participant Limit" }, "pin": { "required": false, "type": "string", "title": "Pin" }, "post_match_string": { "required": false, "type": "string", "title": "Post Match String" }, "post_replace_string": { "required": false, "type": "string", "title": "Post Replace String" }, "primary_owner_email_address": { "required": true, "type": "string", "title": "Primary Owner Email Address" }, "replace_string": { "required": false, "type": "string", "title": "Replace String" }, "resource_uri": { "readonly": true, "required": false, "type": "string", "title": "Resource URI" }, "scheduled_conferences": { "items": { "type": "string" }, "required": false, "type": "array", "title": "Scheduled Conferences" }, "scheduled_conferences_count": { "required": false, "type": "integer", "title": "Scheduled Conferences Count" }, "service_type": { "required": false, "type": "string", "title": "Service Type" }, "sync_tag": { "required": false, "type": "string", "title": "Sync Tag" }, "system_location": { "required": false, "type": "string", "title": "System Location" }, "tag": { "required": false, "type": "string", "title": "Tag" }, "teams_proxy": { "required": false, "type": "string", "title": "Teams Proxy" }, "two_stage_dial_type": { "required": false, "type": "string", "title": "Two_stage_dial_type" } }, "schema_version": "1.0.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/pexip/Conference/add/ |
|
The GUI Add form of device/pexip/Conference 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/pexip/Conference | 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/pexip/Conference/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/pexip/Conference/[pkid1]", "/api/device/pexip/Conference/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/pexip/Conference/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/pexip/Conference/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/pexip/Conference/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/pexip/Conference/[pkid1]", "/api/v0/device/pexip/Conference/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/pexip/Conference/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/pexip/Conference |
|
{"hrefs": ["/api/device/pexip/Conference/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/pexip/Conference |
|
{"hrefs": ["/api/device/pexip/Conference/[pkid1]", "/api/device/pexip/Conference/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/pexip/Conference; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/pexip/Conference/export/ |
|
{ "hrefs":["/api/device/pexip/Conference/[pkid1]", "/api/device/pexip/Conference/[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/pexip/Conference and the JSON format can be used to import instances of device/pexip/Conference.
GET http://[host-proxy]/api/device/pexip/Conference/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/pexip/Conference | POST | /api/device/pexip/Conference/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Tag | PATCH | /api/device/pexip/Conference/+tag/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Tag Version | PATCH | /api/device/pexip/Conference/+tag_version/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/device/pexip/Conference/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/pexip/Conference/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Migration Template | GET | /api/device/pexip/Conference/migration/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/pexip/Conference/ |
|
The device/pexip/Conference schema and all instances as JSON. |
(The list will return 0 to 3 device/pexip/Conference instances)
{ "pagination": { "skip": 0, "limit": 3, "maximum_limit": 2000, "total": 0, "total_limit": null, "order_by": "name", "direction": "asc", "current": "/api/device/pexip/Conference/?skip=0&limit=3&order_by=name&direction=asc&traversal=down" }, "operations": [ "list" ], "meta": { "model_type": "device/pexip/Conference", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "name": "ivr_theme", "title": "IVR Theme" }, { "name": "service_type", "title": "Service Type" }, { "name": "primary_owner_email_address", "title": "Owner's email address" }, { "name": "host_view", "title": "View" }, { "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": [] }, "model_specific_actions": [ "add", "update", "remove", "move", "clone", "export", "export_bulkload_template", "bulk_update_form", "configuration_template", "field_display_policy", "help", "migration", "transform", "tag", "tag_version", "list", "get" ], "schema_version": "1.0.0", "actions": [ { "add": { "method": "GET", "class": "add", "href": "/api/device/pexip/Conference/add/?hierarchy=[hierarchy]", "support_async": false, "title": "Add" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/device/pexip/Conference/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "bulk_update_form": { "method": "GET", "class": "update", "href": "/api/device/pexip/Conference/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "support_async": false, "title": "Bulk Modify" } }, { "move": { "method": "POST", "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/pexip/Conference", "support_async": true, "title": "Move", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "method": "POST", "class": "export", "href": "/api/device/pexip/Conference/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/device/pexip/Conference/export_bulkload_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Export Bulk Load Template" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/device/pexip/Conference/+tag/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/device/pexip/Conference/+tag_version/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "method": "GET", "class": "config", "href": "/api/device/pexip/Conference/configuration_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Configuration Template" } }, { "field_display_policy": { "method": "GET", "class": "display_policy", "href": "/api/device/pexip/Conference/field_display_policy/?hierarchy=[hierarchy]", "support_async": false, "title": "Field Display Policy" } }, { "migration": { "method": "GET", "class": "migration", "href": "/api/device/pexip/Conference/migration/?hierarchy=[hierarchy]", "support_async": false, "title": "Migration Template" } }, { "list": { "method": "GET", "class": "list", "href": "/api/device/pexip/Conference/?hierarchy=[hierarchy]", "support_async": false, "title": "List" } }, { "help": { "method": "GET", "class": "help", "href": "/api/device/pexip/Conference/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } }, { "purge": { "method": "POST", "class": "purge", "href": "/api/device/pexip/Conference/purge/?hierarchy=[hierarchy]", "support_async": false, "title": "Purge" } }, { "transform": { "method": "GET", "class": "transform", "href": "/api/device/pexip/Conference/transform/?hierarchy=[hierarchy]", "support_async": false, "title": "Transform Template" } } ] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/pexip/Conference. | GET | /api/device/pexip/Conference/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/pexip/Conference as HTML |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Purge | POST | /api/device/pexip/Conference/purge/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Transform Template | GET | /api/device/pexip/Conference/transform/ |
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/pexip/Conference/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/pexip/Conference/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/pexip/Conference/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/pexip/Conference/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/pexip/Conference | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Import | POST | /api/device/pexip/Conference/[pkid]/import | 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/pexip/Conference; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/pexip/Conference/[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/pexip/Conference and the JSON format can be used to import instances of device/pexip/Conference.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/device/pexip/Conference/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/pexip/Conference/[pkid] | hierarchy=[hierarchy] | The device/pexip/Conference instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/pexip/Conference/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/pexip/Conference. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/pexip/Conference/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |