[Index]
Model ref.: view/GS_IOSGateway_QuickAdd_View
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": {
"sipGatewayName": {
"required": true,
"type": "string",
"title": "SIP Gateway name"
},
"sipGatewayDescription": {
"type": "string",
"title": "SIP Gateway Description"
},
"country": {
"required": false,
"type": "string",
"title": "Country"
},
"enableCommandBuilder": {
"default": "true",
"type": "boolean",
"title": "Enable Command Builder"
},
"iosName": {
"required": true,
"type": "string",
"title": "IOS Device Name"
},
"overrideVoiceTranslationLimit": {
"type": "boolean",
"title": "Override Voice Translation Limit"
},
"networkAddresses": {
"items": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"title": "Domain"
},
"hostname": {
"type": "string",
"title": "Hostname"
},
"iPAddrV4": {
"format": "ip-address",
"required": true,
"type": "string",
"title": "IPv4 Address"
},
"description": {
"type": "string",
"title": "Description"
},
"addressSpace": {
"choices": [
{
"value": "APPLICATION_SPACE",
"title": "APPLICATION_SPACE"
},
{
"value": "SERVICE_PROVIDER_SPACE",
"title": "SERVICE_PROVIDER_SPACE"
},
{
"value": "CUSTOMER_SPACE",
"title": "CUSTOMER_SPACE"
}
],
"required": true,
"type": "string",
"title": "Address Space"
}
}
},
"type": "array",
"title": "Network Addresses"
},
"iosDescription": {
"type": "string",
"title": "IOS Device Description"
},
"sipTrunkTemplate": {
"required": true,
"type": "string",
"title": "SIP trunk template"
},
"credentials": {
"items": {
"type": "object",
"properties": {
"accessType": {
"default": "RO",
"choices": [
{
"value": "RO",
"title": "RO"
},
{
"value": "RW",
"title": "RW"
}
],
"type": "string",
"title": "Access Type"
},
"password": {
"required": true,
"type": "string",
"is_password": true,
"title": "Password"
},
"userid": {
"required": true,
"type": "string",
"title": "UserId"
},
"credentialType": {
"choices": [
{
"value": "SNMP_V2",
"title": "SNMP_V2"
},
{
"value": "SNMP_V3",
"title": "SNMP_V3"
},
{
"value": "CLI",
"title": "CLI"
}
],
"required": true,
"type": "string",
"title": "Credential Type"
},
"description": {
"type": "string",
"title": "Description"
}
}
},
"type": "array",
"title": "Credentials"
},
"runOnEveryNode": {
"default": "true",
"type": "boolean",
"title": "Run On Every Node"
},
"iosPrimeCollab": {
"type": "string",
"title": "Prime Collaboration"
},
"ports": {
"items": {
"type": "object",
"properties": {
"portNumber": {
"required": true,
"type": "string",
"description": "e.g. 1/0/0",
"title": "Port Number"
},
"description": {
"type": "string",
"title": "Description"
},
"portTemplate": {
"required": true,
"type": "string",
"title": "Port Template"
}
}
},
"type": "array",
"title": "T1/E1 Ports"
}
},
"schema_version": "1.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/GS_IOSGateway_QuickAdd_View/add/ |
|
The GUI Add form of view/GS_IOSGateway_QuickAdd_View 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/view/GS_IOSGateway_QuickAdd_View/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]shows the View resource has no instance pkid, because a view model stores no instances.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for view/GS_IOSGateway_QuickAdd_View | POST | /api/view/GS_IOSGateway_QuickAdd_View/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/view/GS_IOSGateway_QuickAdd_View/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/GS_IOSGateway_QuickAdd_View/ |
|
The view/GS_IOSGateway_QuickAdd_View schema and all instances as JSON. |
(The list will return 0 to 3 view/GS_IOSGateway_QuickAdd_View instances)
{
"operations": [
"add",
"help",
"configuration_template",
"field_display_policy",
"export_bulkload_template",
"transform"
],
"pagination": {
"direction": "asc",
"order_by": null,
"maximum_limit": 2000,
"skip": 0,
"current": "/api/view/GS_IOSGateway_QuickAdd_View/?skip=0&limit=3&order_by=None&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "1.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/view/GS_IOSGateway_QuickAdd_View/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/view/GS_IOSGateway_QuickAdd_View/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/view/GS_IOSGateway_QuickAdd_View/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/view/GS_IOSGateway_QuickAdd_View/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
}
],
"model_type": "view/GS_IOSGateway_QuickAdd_View",
"model_specific_actions": [
"add"
],
"summary_attrs": [
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/view/GS_IOSGateway_QuickAdd_View/[pkid]/ | hierarchy=[hierarchy] | The view/GS_IOSGateway_QuickAdd_View instance with [pkid]. |