[Index]
Model ref.: view/SSRemoteDestination
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": {
"pkid": {
"type": "string",
"title": "RD PKID"
},
"rdp_pkid": {
"type": "string",
"title": "RDP PKID"
},
"active": {
"type": "boolean",
"title": "active"
},
"isSelected": {
"type": "boolean",
"title": "Is Selected"
},
"isSelectable": {
"type": "boolean",
"title": "Is Selectable"
},
"isRecreatingRingSchedule": {
"type": "boolean",
"title": "Is Recreating Ring Schedule"
},
"isCreatedByCallManagerWarningVisible": {
"type": "boolean",
"title": "Is Created By CallManager Warning Visible"
},
"remoteDestinationProfileName": {
"type": "string",
"title": "RDP Name"
},
"singleNumberReachVoicemail": {
"type": "string",
"title": "SNR Voicemail"
},
"hierarchy_path": {
"type": "string",
"title": "Hierarchy Path"
},
"ctiRemoteDeviceName": {
"type": "string",
"title": "CTIRD Name"
},
"dialViaOfficeReverseVoicemail": {
"type": "string",
"title": "Dial Via Office Reverse Voicemail"
},
"mobileSmartClientName": {
"type": "string",
"title": "Mobile Smart Client Name"
},
"ringSchedule": {
"type": "object",
"title": "Ring Schedule",
"properties": {
"member": {
"items": {
"type": "object",
"properties": {
"endDay": {
"type": "string",
"title": "End Day"
},
"startDay": {
"type": "string",
"title": "Start Day"
},
"endTime": {
"type": "string",
"title": "End Time"
},
"startTime": {
"type": "string",
"title": "Start Time"
}
}
},
"type": "array",
"title": "Member"
}
}
},
"hierarchy_friendly_name": {
"type": "string",
"title": "Hierarchy Friendly Path"
},
"isMobilePhone": {
"type": "boolean",
"title": "Is Mobile Phone"
},
"answerTooLateTimer": {
"type": "integer",
"title": "Answer Too Late Timer"
},
"lineAssociations": {
"type": "object",
"title": "Line Associations",
"properties": {
"lineAssociation": {
"items": {
"type": "object",
"properties": {
"pattern": {
"type": "string",
"title": "Pattern"
},
"routePartitionName": {
"type": "string",
"title": "Route Partition Name"
}
}
},
"type": "array",
"title": "Line Association"
}
}
},
"todAccessName": {
"type": "string",
"title": "TOD Access Name"
},
"mobilityProfileName": {
"type": "string",
"title": "Mobility Profile Name"
},
"accessListName": {
"type": "string",
"title": "Access List Name"
},
"delayBeforeRingingCell": {
"type": "integer",
"title": "Delay Before Ringing Cell"
},
"name": {
"type": "string",
"title": "Name"
},
"destination": {
"type": "string",
"title": "Destination"
},
"answerTooSoonTimer": {
"type": "integer",
"title": "Answer Too Soon Timer"
},
"enableMobileConnect": {
"type": "boolean",
"title": "Enable Mobile Connect"
},
"ownerUserId": {
"type": "string",
"title": "Owner User ID"
},
"timeZone": {
"type": "string",
"title": "Time Zone"
},
"enableUnifiedMobility": {
"type": "boolean",
"title": "Enable Unified Mobility"
},
"summary_device": {
"type": "string",
"title": "Summary Device"
},
"lines": {
"type": "object",
"title": "Lines",
"properties": {
"line": {
"items": {
"type": "object",
"properties": {
"pattern": {
"type": "string",
"title": "Pattern"
},
"routePartitionName": {
"type": "string",
"title": "Route Partition Name"
}
}
},
"type": "array",
"title": "Line"
}
}
},
"schedule": {
"type": "object",
"title": "Schedule",
"properties": {
"isTemplate": {
"type": "boolean",
"title": "Is Template"
},
"rsid": {
"type": "string",
"title": "RSID"
},
"name": {
"type": "string",
"title": "TOD Access Name"
},
"pkid": {
"type": "string",
"title": "PKID"
},
"userid": {
"type": "string",
"title": "User ID"
},
"description": {
"type": "string",
"title": "Description"
},
"isDescriptionUpdated": {
"type": "boolean",
"title": "Is Description Updated"
}
}
},
"state": {
"type": "object",
"title": "State",
"properties": {
"ringSchedule": {
"type": "string",
"title": "Ring Schedule"
},
"isRdUpdated": {
"type": "boolean",
"title": "Is RD Updated"
},
"isFmcUpdate": {
"type": "boolean",
"title": "Is FMC Updated"
}
}
},
"timeSchedule": {
"type": "object",
"title": "Time Schedule",
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"pkid": {
"type": "string",
"title": "TS PKID"
}
}
},
"timePeriods": {
"items": {
"type": "object",
"properties": {
"state": {
"type": "string",
"title": "State"
},
"day": {
"type": "string",
"title": "Day"
},
"startTime": {
"type": "string",
"title": "Start Time"
},
"endTime": {
"type": "string",
"title": "End Time"
},
"name": {
"type": "string",
"title": "Name"
},
"pkid": {
"type": "string",
"title": "PKID"
}
}
},
"type": "array",
"title": "Time Periods"
}
},
"schema_version": "1.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/SSRemoteDestination/add/ |
|
The GUI Add form of view/SSRemoteDestination 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/SSRemoteDestination | 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/SSRemoteDestination | POST | /api/view/SSRemoteDestination/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/SSRemoteDestination/ |
|
The view/SSRemoteDestination schema and all instances as JSON. |
(The list will return 0 to 3 view/SSRemoteDestination instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": null,
"direction": "asc",
"current": "/api/view/SSRemoteDestination/?skip=0&limit=3&order_by=None&direction=asc&traversal=down"
},
"operations": [
"add",
"help",
"configuration_template",
"field_display_policy",
"export_bulkload_template",
"transform"
],
"meta": {
"model_type": "view/SSRemoteDestination",
"summary_attrs": [
{
"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"
],
"schema_version": "1.0",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/view/SSRemoteDestination/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/view/SSRemoteDestination/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/view/SSRemoteDestination/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/view/SSRemoteDestination/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for view/SSRemoteDestination. | GET | /api/view/SSRemoteDestination/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/SSRemoteDestination as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/SSRemoteDestination/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/SSRemoteDestination. |