[Index]
Model ref.: view/GS_AGW_AddPort_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": {
"customString3": {
"type": "string",
"description": "Custom String",
"title": "Custom String 3"
},
"customBoolean10": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 10"
},
"customString10": {
"type": "string",
"description": "Custom String",
"title": "Custom String 10"
},
"line_filter": {
"default": "lines_unused_only_local",
"choices": [
{
"value": "lines_unused_only_local",
"title": "Show Unused Numbers (Site only)"
},
{
"value": "default",
"title": "Default"
},
{
"value": "lines_userid_used",
"title": "Show Numbers belonging to this Subscriber"
},
{
"value": "lines_e164_unused_local",
"title": "Show Unused Numbers with Associated E164's (Site Only)"
},
{
"value": "lines_e164_unused",
"title": "Show Unused Numbers with Associated E164's"
},
{
"value": "lines_used_only_local",
"title": "Show Used Numbers (Site Only)"
},
{
"value": "lines_used_only",
"title": "Show Used Numbers"
}
],
"type": "string",
"description": "INI Inventory filter",
"title": "Inventory Filter"
},
"customString6": {
"type": "string",
"description": "Custom String",
"title": "Custom String 6"
},
"slot": {
"type": "string",
"description": "Chassis slot number or module interface slot number.",
"title": "Slot"
},
"GWDomain": {
"target": "/api/device/cucm/Gateway/choices/?field=domainName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": true,
"choices": [],
"target_attr": "domainName",
"target_model_type": "device/cucm/Gateway",
"title": "Gateway Domain",
"type": "string"
},
"customBoolean6": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 6"
},
"dnToTranslate": {
"type": "string",
"description": "dn to use for E164 lookup",
"title": "dnToTranslate"
},
"GWProduct": {
"type": "string",
"title": "Gateway Product"
},
"subunit": {
"type": "string",
"description": "Gateway subunit module.",
"title": "SubUnit"
},
"css": {
"required": true,
"type": "string",
"description": "Line CSS. Used only when creating new lines",
"title": "Calling Search Space"
},
"dn": {
"type": "string",
"description": "DN to use for new line - auto populates with next available line at the site",
"title": "Directory Number"
},
"customString2": {
"type": "string",
"description": "Custom String",
"title": "Custom String 2"
},
"customString1": {
"type": "string",
"description": "Custom String",
"title": "Custom String 1"
},
"customString7": {
"type": "string",
"description": "Custom String",
"title": "Custom String 7"
},
"description": {
"type": "string",
"description": "Analog Gateway description.",
"title": "Description"
},
"customString5": {
"type": "string",
"description": "Custom String",
"title": "Custom String 5"
},
"customString4": {
"type": "string",
"description": "Custom String",
"title": "Custom String 4"
},
"customString9": {
"type": "string",
"description": "Custom String",
"title": "Custom String 9"
},
"customString8": {
"type": "string",
"description": "Custom String",
"title": "Custom String 8"
},
"SCCPTemplateName": {
"type": "string",
"description": "Note: When creating a new custom CFT for this dropdown, feature_usage array needs to contain - 'AddPortToAnalogGateway'. For example - \"feature_usage\": [\"AddPortToAnalogGateway\"].",
"title": "SCCP Template Name"
},
"customBoolean2": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 2"
},
"customBoolean7": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 7"
},
"GWProtocol": {
"type": "string",
"title": "Gateway Protocol"
},
"customBoolean5": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 5"
},
"customBoolean4": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 4"
},
"customBoolean3": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 3"
},
"MGCPTemplateName": {
"type": "string",
"description": "Note: When creating a new custom CFT for this dropdown, feature_usage array needs to contain - 'AddPortToAnalogGateway'. For example - \"feature_usage\": [\"AddPortToAnalogGateway\"].",
"title": "MGCP Template Name"
},
"customBoolean1": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 1"
},
"userid": {
"type": "string",
"description": "From the drop-down list box, choose the user ID of the assigned phone user. The user ID gets recorded in the call detail record (CDR) for all calls made from this device. Assigning a user ID to the device also moves the device from \"Unassigned Devices\" to \"Users\" in the License Usage Report.",
"title": "Owner User ID"
},
"customBoolean9": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 9"
},
"customBoolean8": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 8"
},
"maxPorts": {
"type": "string",
"description": "Max number of ports per subunit.",
"title": "Max ports per subunit"
}
},
"schema_version": "1.3"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/GS_AGW_AddPort_VIEW/add/ |
|
The GUI Add form of view/GS_AGW_AddPort_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_AGW_AddPort_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_AGW_AddPort_VIEW | POST | /api/view/GS_AGW_AddPort_VIEW/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/view/GS_AGW_AddPort_VIEW/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/view/GS_AGW_AddPort_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_AGW_AddPort_VIEW/ |
|
The view/GS_AGW_AddPort_VIEW schema and all instances as JSON. |
(The list will return 0 to 3 view/GS_AGW_AddPort_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_AGW_AddPort_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.3",
"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_AGW_AddPort_VIEW/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/view/GS_AGW_AddPort_VIEW/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/view/GS_AGW_AddPort_VIEW/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/view/GS_AGW_AddPort_VIEW/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/view/GS_AGW_AddPort_VIEW/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/view/GS_AGW_AddPort_VIEW/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/view/GS_AGW_AddPort_VIEW/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/view/GS_AGW_AddPort_VIEW/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/view/GS_AGW_AddPort_VIEW/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "view/GS_AGW_AddPort_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 the on-line Help for view/GS_AGW_AddPort_VIEW. | GET | /api/view/GS_AGW_AddPort_VIEW/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/GS_AGW_AddPort_VIEW as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/view/GS_AGW_AddPort_VIEW/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/view/GS_AGW_AddPort_VIEW/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/view/GS_AGW_AddPort_VIEW/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/view/GS_AGW_AddPort_VIEW/[pkid] | hierarchy=[hierarchy] | The view/GS_AGW_AddPort_VIEW instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/GS_AGW_AddPort_VIEW/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/GS_AGW_AddPort_VIEW. |