[Index]
Associate a voice mail service pilot number with a site.
Model ref.: relation/HcsDpAssociateVmPilotToSiteREL
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": { "siteName": { "is_password": false, "target_model_type": "data/BaseSiteDAT", "description": "The site for which we are associating a voice mail service pilot number.", "format": "uri", "required": false, "displayable": false, "choices": [], "target_attr": "SiteName", "readonly": false, "maxLength": 1024, "title": "Site Name", "type": "string", "target": "/api/data/BaseSiteDAT/choices/?field=SiteName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "voiceMailService": { "is_password": false, "description": "The Voice Mail Service to associate with the site.", "title": "Voice Mail Service", "required": true, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "pilotNumber": { "is_password": false, "description": "The voice mail pilot number to associate with the site.", "title": "Voice Mail Service Pilot Number", "required": true, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" }, "shadow": { "items": { "type": "object", "properties": { "name": { "is_password": false, "title": "Name", "required": true, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" } } }, "type": "array", "maxItems": 1, "title": "Shadow" }, "e164Number": { "is_password": false, "description": "The E164 Number to associate with the Pilot Number.", "title": "E164 Number", "required": false, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" } }, "schema_version": "2.1" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/relation/HcsDpAssociateVmPilotToSiteREL/add/ |
|
The GUI Add form of relation/HcsDpAssociateVmPilotToSiteREL 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/HcsDpAssociateVmPilotToSiteREL/ | 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/HcsDpAssociateVmPilotToSiteREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsDpAssociateVmPilotToSiteREL/[pkid1]", "/api/relation/HcsDpAssociateVmPilotToSiteREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsDpAssociateVmPilotToSiteREL/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsDpAssociateVmPilotToSiteREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsDpAssociateVmPilotToSiteREL/export/ |
|
{ "hrefs":["/api/relation/HcsDpAssociateVmPilotToSiteREL/[pkid1]", "/api/relation/HcsDpAssociateVmPilotToSiteREL/[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/HcsDpAssociateVmPilotToSiteREL and the JSON format can be used to import instances of relation/HcsDpAssociateVmPilotToSiteREL.
GET http://[host-proxy]/api/relation/HcsDpAssociateVmPilotToSiteREL/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for relation/HcsDpAssociateVmPilotToSiteREL | POST | /api/relation/HcsDpAssociateVmPilotToSiteREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/relation/HcsDpAssociateVmPilotToSiteREL/ |
|
The relation/HcsDpAssociateVmPilotToSiteREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsDpAssociateVmPilotToSiteREL instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "list", "update", "remove", "add", "bulk_update", "export" ], "pagination": { "direction": "asc", "order_by": "voiceMailService", "maximum_limit": 2000, "skip": 0, "current": "/api/relation/HcsDpAssociateVmPilotToSiteREL/?skip=0&limit=3&order_by=voiceMailService&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "2.1", "references": { "device": [ { "pkid": "", "href": "" } ], "self": [ { "pkid": null, "href": "/api/relation/HcsDpAssociateVmPilotToSiteREL/None/" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/relation/HcsDpAssociateVmPilotToSiteREL/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/relation/HcsDpAssociateVmPilotToSiteREL/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/relation/HcsDpAssociateVmPilotToSiteREL/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/HcsDpAssociateVmPilotToSiteREL/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "list": { "support_async": false, "class": "list", "href": "/api/relation/HcsDpAssociateVmPilotToSiteREL/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/relation/HcsDpAssociateVmPilotToSiteREL/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "relation/HcsDpAssociateVmPilotToSiteREL", "model_specific_actions": [ "help", "get", "export_bulkload_template", "list", "update", "remove", "add", "export" ], "summary_attrs": [ { "name": "voiceMailService", "title": "Voice Mail Service" }, { "name": "pilotNumber", "title": "Voice Mail Service Pilot Number" }, { "name": "siteName", "title": "Site Name" }, { "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 relation/HcsDpAssociateVmPilotToSiteREL. | GET | /api/relation/HcsDpAssociateVmPilotToSiteREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsDpAssociateVmPilotToSiteREL as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/relation/HcsDpAssociateVmPilotToSiteREL/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/relation/HcsDpAssociateVmPilotToSiteREL/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsDpAssociateVmPilotToSiteREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsDpAssociateVmPilotToSiteREL/[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/HcsDpAssociateVmPilotToSiteREL and the JSON format can be used to import instances of relation/HcsDpAssociateVmPilotToSiteREL.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/relation/HcsDpAssociateVmPilotToSiteREL/[pkid]/ | hierarchy=[hierarchy] | The relation/HcsDpAssociateVmPilotToSiteREL instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/relation/HcsDpAssociateVmPilotToSiteREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsDpAssociateVmPilotToSiteREL. |