[Index]
Model ref.: device/cuc/PrivateListMember
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": { "MemberDistributionListObjectId": { "target": "/api/device/cuc/DistributionList/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "minItems": 0, "description": " The member of this personal group. If the member is a distribution list, the unique identifier of the corresponding DistributionList object in tbl_DistributionList. Otherwise, this attribute is set ot NULL.", "title": "Member Distribution List Object Id", "choices": [], "target_attr": "ObjectId", "target_model_type": "device/cuc/DistributionList", "type": [ "string" ], "name": "MemberDistributionListObjectId" }, "MemberSubscriberObjectId": { "target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "minItems": 0, "description": " The member of this personal group. If the member is a user, the ObjectId of the user(s). Otherwise, this attribute is set ot NULL.", "title": "Member Subscriber Object Id", "choices": [], "target_attr": "ObjectId", "target_model_type": "device/cuc/User", "type": [ "string" ], "name": "MemberSubscriberObjectId" }, "MemberPersonalVoiceMailListObjectId": { "target": "/api/device/cuc/PrivateList/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "minItems": 0, "description": " The member of this personal group. If the member is another personal group, the unique identifier of the corresponding PersonalGroup object in tbl_PersonalGroup. Otherwise, this attribute is set ot NULL.", "title": "Member Personal Voice Mail List Object Id", "choices": [], "target_attr": "ObjectId", "target_model_type": "device/cuc/PrivateList", "type": [ "string" ], "name": "MemberPersonalVoiceMailListObjectId" }, "ObjectId": { "description": " Surrogate key. A globally unique, system-generated identifier for a PersonalGroupMember object. - template parameter [3]", "title": "Object Id", "minItems": 0, "readonly": true, "type": "string", "name": "ObjectId" }, "Extension": { "readonly": true, "type": "string", "description": "Extension of private list member.", "name": "Extension", "title": "Extension" }, "PrivateListURI": { "name": "PrivateListURI", "format": "uri", "minItems": 0, "title": "Private List URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "MemberDistributionListURI": { "name": "MemberDistributionListURI", "format": "uri", "minItems": 0, "title": "Member Distribution List URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "URI": { "name": "URI", "format": "uri", "minItems": 0, "title": "URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "PersonalVoiceMailListObjectId": { "description": " The unique identifier of the PersonalGroup object to which this member belongs. - template parameter [2]", "format": "uri", "minItems": 0, "title": "Personal Voice Mail List Object Id", "required": true, "choices": [], "target_attr": "ObjectId", "readonly": true, "target": "/api/device/cuc/PrivateList/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_model_type": "device/cuc/PrivateList", "type": [ "string" ], "name": "PersonalVoiceMailListObjectId" }, "Alias": { "readonly": true, "type": "string", "description": "Alias of private list member.", "name": "Alias", "title": "Alias" }, "MemberUserURI": { "name": "MemberUserURI", "format": "uri", "minItems": 0, "title": "Member User URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "MemberPrivateListURI": { "name": "MemberPrivateListURI", "format": "uri", "minItems": 0, "title": "Member Private List URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "MemberContactURI": { "name": "MemberContactURI", "format": "uri", "minItems": 0, "title": "Member Contact URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "MemberContactObjectId": { "target": "/api/device/cuc/Contact/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "minItems": 0, "description": " The member of this personal group. If the member is a system contact, the unique identifier of the corresponding Contact object in tbl_Contact. Otherwise, this attribute is set ot NULL.", "title": "Member Contact Object Id", "choices": [], "target_attr": "ObjectId", "target_model_type": "device/cuc/Contact", "type": [ "string" ], "name": "MemberContactObjectId" }, "UserObjectId": { "description": "template parameter [1]", "name": "UserObjectId", "format": "uri", "title": "User Object Id", "required": true, "choices": [], "target_attr": "ObjectId", "target_model_type": "device/cuc/User", "type": [ "string" ], "target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "DisplayName": { "readonly": true, "type": "string", "description": "Display name of private list member.", "name": "DisplayName", "title": "Display Name" } }, "schema_version": "14.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/cuc/PrivateListMember/add/ |
|
The GUI Add form of device/cuc/PrivateListMember 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/device/cuc/PrivateListMember | 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/device/cuc/PrivateListMember/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/PrivateListMember/[pkid1]", "/api/device/cuc/PrivateListMember/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/PrivateListMember/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cuc/PrivateListMember/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cuc/PrivateListMember/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/PrivateListMember/[pkid1]", "/api/v0/device/cuc/PrivateListMember/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/PrivateListMember/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cuc/PrivateListMember |
|
{"hrefs": ["/api/device/cuc/PrivateListMember/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/PrivateListMember |
|
{"hrefs": ["/api/device/cuc/PrivateListMember/[pkid1]", "/api/device/cuc/PrivateListMember/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/PrivateListMember; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/PrivateListMember/export/ |
|
{ "hrefs":["/api/device/cuc/PrivateListMember/[pkid1]", "/api/device/cuc/PrivateListMember/[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 device/cuc/PrivateListMember and the JSON format can be used to import instances of device/cuc/PrivateListMember.
GET http://[host-proxy]/api/device/cuc/PrivateListMember/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/PrivateListMember | POST | /api/device/cuc/PrivateListMember/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/device/cuc/PrivateListMember/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/cuc/PrivateListMember/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cuc/PrivateListMember/ |
|
The device/cuc/PrivateListMember schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/PrivateListMember instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cuc/PrivateListMember/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "14.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/device/cuc/PrivateListMember/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/PrivateListMember/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/cuc/PrivateListMember/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Bulk Modify" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cuc/PrivateListMember", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/PrivateListMember/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/device/cuc/PrivateListMember/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cuc/PrivateListMember/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cuc/PrivateListMember/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cuc/PrivateListMember/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/PrivateListMember/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/PrivateListMember/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/PrivateListMember", "model_specific_actions": [ "add", "list", "get", "remove", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "DisplayName", "title": "Display 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 device/cuc/PrivateListMember. | GET | /api/device/cuc/PrivateListMember/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/PrivateListMember as HTML |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/cuc/PrivateListMember/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/PrivateListMember/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/PrivateListMember/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/PrivateListMember | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of device/cuc/PrivateListMember; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/PrivateListMember/[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 device/cuc/PrivateListMember and the JSON format can be used to import instances of device/cuc/PrivateListMember.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cuc/PrivateListMember/[pkid] | hierarchy=[hierarchy] | The device/cuc/PrivateListMember instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cuc/PrivateListMember/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/PrivateListMember. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cuc/PrivateListMember/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |