[Index]
Model ref.: relation/PRSSwitchREL
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": {
"application_space": {
"is_password": false,
"title": "Application Space",
"required": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"name": {
"is_password": false,
"title": "Server Name",
"required": true,
"readonly": false,
"maxLength": 64,
"type": "string"
},
"virtualMachine": {
"is_password": false,
"title": "Virtual Machine",
"required": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"typeDeploymentMode": {
"is_password": false,
"title": "Deployment Mode",
"required": true,
"choices": [
{
"value": "HCS",
"title": "HCS"
},
{
"value": "Standalone",
"title": "Standalone"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"backup_application_space": {
"is_password": false,
"title": "Backup Application Space",
"required": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"cucm": {
"title": "HCS CUCM",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"hcsCucm": {
"type": "string",
"title": "CUCM"
}
}
},
"required": false,
"maxItems": 16,
"type": "array"
},
"networkAddresses": {
"is_password": false,
"title": "Network Addresses",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"typeAddressSpace": {
"is_password": false,
"title": "Type Address Space",
"required": true,
"choices": [
{
"value": "APPLICATION_SPACE",
"title": "APPLICATION_SPACE"
},
{
"value": "SERVICE_PROVIDER_SPACE",
"title": "SERVICE_PROVIDER_SPACE"
},
{
"value": "CUSTOMER_SPACE",
"title": "CUSTOMER_SPACE"
},
{
"value": "BACKUP_APPLICATION_SPACE",
"title": "BACKUP_APPLICATION_SPACE"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"iPAddrV4": {
"is_password": false,
"title": "IP Addr V4",
"required": false,
"readonly": false,
"maxLength": 64,
"type": "string"
},
"description": {
"is_password": false,
"title": "Description",
"required": false,
"readonly": false,
"maxLength": 128,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"version": {
"is_password": false,
"title": "Version",
"required": true,
"choices": [
{
"value": "1.0.0",
"title": "1.0.0"
}
],
"readonly": false,
"maxLength": 128,
"type": "string"
},
"connParms": {
"type": "object",
"properties": {
"username": {
"required": false,
"type": "string",
"description": "Username to use with specified authentication method.",
"title": "Username"
},
"name": {
"required": true,
"type": "string",
"description": "Name for this instance of generic driver connection details.",
"title": "Name"
},
"driver_parameters": {
"items": {
"type": "object",
"properties": {
"name": {
"required": true,
"type": "string",
"description": "Name of additional driver parameter.",
"title": "Name"
},
"value": {
"required": true,
"type": "string",
"description": "Value of additional driver parameter.",
"title": "Value"
}
}
},
"type": "array",
"description": "Additional parameters for the driver",
"title": "Driver Parameters"
},
"test_connection_uri": {
"type": "string",
"description": "URI to use when testing connection to external service, e.g. https://service.domain/api/health, {{ driver_parameters.host_base }}/status",
"title": "Test Connection URI"
},
"default_request_headers": {
"items": {
"type": "object",
"properties": {
"name": {
"required": true,
"type": "string",
"description": "Name of HTTP request header, e.g. Accept.",
"title": "Name"
},
"value": {
"required": true,
"type": "string",
"description": "Value of HTTP request header, e.g. text/plain.",
"title": "Value"
}
}
},
"type": "array",
"description": "Default HTTP request headers to send with all device model API operation requests. Defaults specified here will be overriden by request headers specified on individual device model API operation definitions.",
"title": "Default Request Headers"
},
"default_response_handlers": {
"items": {
"type": "object",
"properties": {
"type": {
"choices": [
{
"value": "backoff_retry",
"title": "Backoff & Retry"
},
{
"value": "failure_duplicate",
"title": "Failure - Duplicate"
},
{
"value": "invalid_session",
"title": "Invalid Session"
}
],
"required": true,
"type": "string",
"description": "Response handler type to execute if specified condition evaluates to True, e.g. Backoff & Retry.",
"title": "Type"
},
"condition": {
"required": true,
"type": "string",
"description": "Jinja template which if evaluation results in a value of True will cause the specified handler type to be executed, e.g. {{ status_code == 429 }}.",
"title": "Condition"
}
}
},
"type": "array",
"description": "Default handlers to execute on all API operation responses. Only those response handlers' which condition evaluates to True are executed.",
"title": "Default Response Handlers"
},
"token": {
"is_password": true,
"description": "Token to use with specified authentication method.",
"title": "Token",
"required": false,
"store_encrypted": true,
"type": "string"
},
"version": {
"pattern": "^[0-9]+?(\\.[0-9]+?)+?$",
"required": true,
"type": "string",
"description": "Version of models to use.",
"title": "Version"
},
"session_based_auth_request": {
"properties": {
"login_uri": {
"type": "string",
"description": "URI for the API Login request.",
"title": "Login URI"
},
"session_headers": {
"items": {
"type": "object",
"properties": {
"session_header_name": {
"type": "string",
"description": "Name of session request header, e.g. Cookie.",
"title": "Header Name"
},
"session_header_value": {
"type": "string",
"description": "Value of session request header, e.g. session=12345.",
"title": "Header Value"
}
}
},
"type": "array",
"description": "Session headers to include for all requests.",
"title": "Headers"
},
"request_template": {
"type": "string",
"description": "A request template that will be used for POST requests.",
"title": "Request Template for POST requests"
},
"session_expire_minutes": {
"type": "integer",
"description": "The amount of time a session is valid specifiec in minutes.",
"title": "Session Expire Time (min)"
},
"login_http_method": {
"default": "POST",
"choices": [
{
"value": "GET",
"title": "GET"
},
{
"value": "POST",
"title": "POST"
}
],
"type": "string",
"description": "HTTP method for API login request.",
"title": "Login HTTP Method"
},
"use_request_body": {
"type": "boolean",
"description": "Use a request body to send login credentials.",
"title": "Use Request Body on Login"
}
},
"type": "object",
"description": "Describes the API request required to obtain a valid auth token.",
"title": "Session Based Auth Request"
},
"password": {
"is_password": true,
"description": "Password to use with specified authentication method.",
"title": "Password",
"required": false,
"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"
},
{
"value": "OCIP",
"title": "Broadsoft OCIP socket based authentication protocol"
}
],
"required": true,
"type": "string",
"description": "Type of authentication to use when interfacing to the external service.",
"title": "Authentication Method"
},
"description": {
"required": true,
"type": "string",
"description": "Description for this instance of generic driver connection details.",
"title": "Description"
}
},
"title": "Conn Parms"
},
"credentials": {
"is_password": false,
"title": "Credentials",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"password": {
"is_password": true,
"title": "Password",
"required": false,
"readonly": false,
"maxLength": 512,
"store_encrypted": true,
"type": "string"
},
"userID": {
"is_password": false,
"title": "User ID",
"required": false,
"readonly": false,
"maxLength": 256,
"type": "string"
},
"description": {
"is_password": false,
"title": "Description",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"typeCredential": {
"is_password": false,
"title": "Type Credential",
"required": true,
"choices": [
{
"value": "API",
"title": "API"
},
{
"value": "CLI",
"title": "CLI"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"ntpServer": {
"is_password": false,
"title": "NTP Server for phones",
"required": true,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"description": {
"is_password": false,
"title": "Description",
"required": true,
"readonly": false,
"maxLength": 128,
"type": "string"
}
},
"schema_version": "2.4"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/PRSSwitchREL/add/ |
|
The GUI Add form of relation/PRSSwitchREL 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/relation/PRSSwitchREL/ | 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/relation/PRSSwitchREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/PRSSwitchREL/[pkid1]", "/api/relation/PRSSwitchREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/PRSSwitchREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/PRSSwitchREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/PRSSwitchREL/export/ |
|
{ "hrefs":["/api/relation/PRSSwitchREL/[pkid1]", "/api/relation/PRSSwitchREL/[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/PRSSwitchREL and the JSON format can be used to import instances of relation/PRSSwitchREL.
GET http://[host-proxy]/api/relation/PRSSwitchREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/PRSSwitchREL | POST | /api/relation/PRSSwitchREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/PRSSwitchREL/ |
|
The relation/PRSSwitchREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/PRSSwitchREL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/PRSSwitchREL/?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": "2.4",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/PRSSwitchREL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/PRSSwitchREL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/PRSSwitchREL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/PRSSwitchREL/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/PRSSwitchREL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/PRSSwitchREL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/PRSSwitchREL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/PRSSwitchREL",
"model_specific_actions": [
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"export"
],
"summary_attrs": [
{
"name": "name",
"title": "Server Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/PRSSwitchREL. | GET | /api/relation/PRSSwitchREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/PRSSwitchREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/PRSSwitchREL/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/PRSSwitchREL/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/PRSSwitchREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/PRSSwitchREL/[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/PRSSwitchREL and the JSON format can be used to import instances of relation/PRSSwitchREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/PRSSwitchREL/[pkid]/ | hierarchy=[hierarchy] | The relation/PRSSwitchREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/PRSSwitchREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/PRSSwitchREL. |