[Index]
This model stores information about an AudioCodes Connection
Model ref.: data/AudioCodesConnection
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": { "is_password": false, "description": "AudioCodes Connection service account.", "title": "Username", "required": true, "maxLength": 255, "type": "string" }, "name": { "maxLength": 255, "required": true, "type": "string", "description": "AudioCodes Connection defined name, can be an IP address or a host name and can have a max length of 255 charactors", "title": "Name" }, "host": { "maxLength": 255, "required": true, "type": "string", "description": "AudioCodes Connection host, can be an IP address or a host name.", "title": "Audio Codes Routing Manager" }, "version": { "default": "v1.0", "required": true, "type": "string", "description": "Version", "title": "Version" }, "syncAudioCodesConnection": { "default": false, "type": "boolean", "description": "Sync AudioCodes Connection on Create and Update. When this checkbox is checked it will execute a full Pull Sync from the AudioCodes Connection.", "title": "AudioCodes Connection sync on Create/Update" }, "password": { "is_password": true, "description": "AudioCodes Connection password of the above service account.", "title": "Password", "required": true, "maxLength": 255, "store_encrypted": true, "type": "string" }, "auth_method": { "choices": [ { "value": "BASIC", "title": "HTTP Basic Authentication" }, { "value": "OAUTH", "title": "OAuth(OApen Authorization)" }, { "value": "SESSION", "title": "Session Based Authentication" } ], "required": false, "type": "string", "description": "Type of authentication to use when interfacing to the external service.", "title": "Authentication Method" }, "description": { "title": "Description", "type": "string", "description": "AudioCodes Connection defined description.", "maxLength": 255 } }, "schema_version": "0.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/AudioCodesConnection/add/ |
|
The GUI Add form of data/AudioCodesConnection 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/data/AudioCodesConnection | 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/data/AudioCodesConnection/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/AudioCodesConnection/[pkid1]", "/api/data/AudioCodesConnection/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/AudioCodesConnection/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/AudioCodesConnection; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/AudioCodesConnection/export/ |
|
{ "hrefs":["/api/data/AudioCodesConnection/[pkid1]", "/api/data/AudioCodesConnection/[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/AudioCodesConnection and the JSON format can be used to import instances of data/AudioCodesConnection.
GET http://[host-proxy]/api/data/AudioCodesConnection/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/AudioCodesConnection | POST | /api/data/AudioCodesConnection/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/data/AudioCodesConnection/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/data/AudioCodesConnection/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/AudioCodesConnection/ |
|
The data/AudioCodesConnection schema and all instances as JSON. |
(The list will return 0 to 3 data/AudioCodesConnection instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "list", "update", "remove", "move", "transform", "add", "export", "migration", "bulk_update_form" ], "pagination": { "direction": "asc", "order_by": "name", "maximum_limit": 2000, "skip": 0, "current": "/api/data/AudioCodesConnection/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "0.0", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/data/AudioCodesConnection/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/AudioCodesConnection/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/AudioCodesConnection/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/data/AudioCodesConnection/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/AudioCodesConnection/+tag/?hierarchy=[hierarchy]", "class": "tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/data/AudioCodesConnection/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/data/AudioCodesConnection/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/data/AudioCodesConnection/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/AudioCodesConnection/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/AudioCodesConnection", "model_specific_actions": [ "add", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "get", "help", "list", "remove", "tag", "update" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "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 data/AudioCodesConnection. | GET | /api/data/AudioCodesConnection/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/AudioCodesConnection as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/AudioCodesConnection/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/AudioCodesConnection/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of data/AudioCodesConnection; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/AudioCodesConnection/[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 data/AudioCodesConnection and the JSON format can be used to import instances of data/AudioCodesConnection.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/data/AudioCodesConnection/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/AudioCodesConnection/[pkid] | hierarchy=[hierarchy] | The data/AudioCodesConnection instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/AudioCodesConnection/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/AudioCodesConnection. |