[Index]
Wrapper relation for InternalNumberInventory. Summary attributes is defined in data-model (and in future core-versions, the FDP will define the summary-attrs)
Model ref.: relation/NumberInventoryREL
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": { "status": { "title": "Status", "required": true, "type": "string", "choices": [ { "value": "Available", "title": "Available" }, { "value": "Used", "title": "Used" }, { "value": "Used-Utility", "title": "Used-Utility" }, { "value": "Reserved", "title": "Reserved" }, { "value": "Cooling", "title": "Cooling" } ] }, "internal_number": { "required": true, "type": "string", "title": "Internal Number" }, "vendor": { "type": "string", "title": "Vendor" }, "description": { "type": "string", "title": "Description" }, "extra1": { "type": "string", "title": "Extra1" }, "release_date": { "type": "string", "description": "A value indicates that the number is in temporary 'cooldown' isolation (and therefore also temporarily unavailable until the cooling duration expires, refer to global settings).", "title": "Release Date" }, "lsview": { "type": "object", "properties": { "callpark_directed9_link": { "format": "link", "type": "string", "title": "Directed Call Park" }, "cpug2_link": { "format": "link", "type": "string", "title": "Call Pickup Group Pilot" }, "callpark_directed1_link": { "format": "link", "type": "string", "title": "Directed Call Park" }, "meetme1_link": { "format": "link", "type": "string", "title": "Meet Me" }, "user3_link": { "format": "link", "type": "string", "title": "User" }, "cpug1_link": { "format": "link", "type": "string", "title": "Call Pickup Group Pilot" }, "vossphone_link": { "format": "link", "type": "string", "title": "VOSS Phone" }, "user9_link": { "format": "link", "type": "string", "title": "User" }, "user6_link": { "format": "link", "type": "string", "title": "User" }, "callpark2_link": { "format": "link", "type": "string", "title": "Call Park" }, "callpark5_link": { "format": "link", "type": "string", "title": "Call Park" }, "callpark_directed10_link": { "format": "link", "type": "string", "title": "Directed Call Park" }, "device_profile_link": { "format": "link", "type": "string", "title": "Device Profile" }, "ctirp_link": { "format": "link", "type": "string", "title": "CTI Route Point" }, "cpug9_link": { "format": "link", "type": "string", "title": "Call Pickup Group Pilot" }, "systemcallhandler_link": { "format": "link", "type": "string", "title": "System Call Handler" }, "callpark_directed8_link": { "format": "link", "type": "string", "title": "Directed Call Park" }, "cpug10_link": { "format": "link", "type": "string", "title": "Call Pickup Group Pilot" }, "hunt_group10_link": { "format": "link", "type": "string", "title": "Hunt Line Group Member" }, "callpark_directed2_link": { "format": "link", "type": "string", "title": "Directed Call Park" }, "phone6_link": { "format": "link", "type": "string", "title": "Phone" }, "line8_link": { "format": "link", "type": "string", "title": "Line (Partition)" }, "line5_link": { "format": "link", "type": "string", "title": "Line (Partition)" }, "hunt_group5_link": { "format": "link", "type": "string", "title": "Hunt Line Group Member" }, "callpark3_link": { "format": "link", "type": "string", "title": "Call Park" }, "meetme3_link": { "format": "link", "type": "string", "title": "Meet Me" }, "line6_link": { "format": "link", "type": "string", "title": "Line (Partition)" }, "phone9_link": { "format": "link", "type": "string", "title": "Phone" }, "cpug3_link": { "format": "link", "type": "string", "title": "Call Pickup Group Pilot" }, "meetme5_link": { "format": "link", "type": "string", "title": "Meet Me" }, "cpug4_link": { "format": "link", "type": "string", "title": "Call Pickup Group Pilot" }, "huntpilot7_link": { "format": "link", "type": "string", "title": "Hunt Pilot" }, "huntpilot10_link": { "format": "link", "type": "string", "title": "Hunt Pilot" }, "meetme8_link": { "format": "link", "type": "string", "title": "Meet Me" }, "huntpilot2_link": { "format": "link", "type": "string", "title": "Hunt Pilot" }, "hunt_group1_link": { "format": "link", "type": "string", "title": "Hunt Line Group Member" }, "meetme7_link": { "format": "link", "type": "string", "title": "Meet Me" }, "hunt_group6_link": { "format": "link", "type": "string", "title": "Hunt Line Group Member" }, "phone5_link": { "format": "link", "type": "string", "title": "Phone" }, "line7_link": { "format": "link", "type": "string", "title": "Line (Partition)" }, "search_line": { "type": "string", "title": "Search Line" }, "voicemail_link": { "format": "link", "type": "string", "title": "Voicemail User" }, "huntpilot6_link": { "format": "link", "type": "string", "title": "Hunt Pilot" }, "meetme4_link": { "format": "link", "type": "string", "title": "Meet Me" }, "vmpilot_link": { "format": "link", "type": "string", "title": "Voicemail Pilot" }, "callpark4_link": { "format": "link", "type": "string", "title": "Call Park" }, "user8_link": { "format": "link", "type": "string", "title": "User" }, "cpug7_link": { "format": "link", "type": "string", "title": "Call Pickup Group Pilot" }, "meetme10_link": { "format": "link", "type": "string", "title": "Meet Me" }, "callpark1_link": { "format": "link", "type": "string", "title": "Call Park" }, "meetme_link": { "format": "link", "type": "string", "title": "Meet Me" }, "phone4_link": { "format": "link", "type": "string", "title": "Phone" }, "phone2_link": { "format": "link", "type": "string", "title": "Phone" }, "callpark7_link": { "format": "link", "type": "string", "title": "Call Park" }, "huntpilot4_link": { "format": "link", "type": "string", "title": "Hunt Pilot" }, "phone7_link": { "format": "link", "type": "string", "title": "Phone" }, "hunt_group7_link": { "format": "link", "type": "string", "title": "Hunt Line Group Member" }, "callpark_directed4_link": { "format": "link", "type": "string", "title": "Directed Call Park" }, "line4_link": { "format": "link", "type": "string", "title": "Line (Partition)" }, "user5_link": { "format": "link", "type": "string", "title": "User" }, "callpark_directed7_link": { "format": "link", "type": "string", "title": "Directed Call Park" }, "line1_link": { "format": "link", "type": "string", "title": "Line (Partition)" }, "huntpilot3_link": { "format": "link", "type": "string", "title": "Hunt Pilot" }, "meetme6_link": { "format": "link", "type": "string", "title": "Meet Me" }, "phone3_link": { "format": "link", "type": "string", "title": "Phone" }, "callpark_directed5_link": { "format": "link", "type": "string", "title": "Directed Call Park" }, "callpark10_link": { "format": "link", "type": "string", "title": "Call Park" }, "huntpilot1_link": { "format": "link", "type": "string", "title": "Hunt Pilot" }, "line3_link": { "format": "link", "type": "string", "title": "Line (Partition)" }, "user2_link": { "format": "link", "type": "string", "title": "User" }, "call_pickup_group_link": { "format": "link", "type": "string", "title": "Call Pickup Group Member" }, "hunt_group9_link": { "format": "link", "type": "string", "title": "Hunt Line Group Member" }, "hunt_group8_link": { "format": "link", "type": "string", "title": "Hunt Line Group Member" }, "cpug5_link": { "format": "link", "type": "string", "title": "Call Pickup Group Pilot" }, "cpug8_link": { "format": "link", "type": "string", "title": "Call Pickup Group Pilot" }, "line2_link": { "format": "link", "type": "string", "title": "Line (Partition)" }, "callpark_directed6_link": { "format": "link", "type": "string", "title": "Directed Call Park" }, "remote_destination_profile_link": { "format": "link", "type": "string", "title": "Remote Destination Profile" }, "user1_link": { "format": "link", "type": "string", "title": "User" }, "line9_link": { "format": "link", "type": "string", "title": "Line (Partition)" }, "user4_link": { "format": "link", "type": "string", "title": "User" }, "phone1_link": { "format": "link", "type": "string", "title": "Phone" }, "user7_link": { "format": "link", "type": "string", "title": "User" }, "hunt_group4_link": { "format": "link", "type": "string", "title": "Hunt Line Group Member" }, "hunt_group3_link": { "format": "link", "type": "string", "title": "Hunt Line Group Member" }, "callpark6_link": { "format": "link", "type": "string", "title": "Call Park" }, "user10_link": { "format": "link", "type": "string", "title": "User" }, "msteams_onpremline_link": { "format": "link", "type": "string", "title": "MS Teams Line URI" }, "cpug6_link": { "format": "link", "type": "string", "title": "Call Pickup Group Pilot" }, "meetme9_link": { "format": "link", "type": "string", "title": "Meet Me" }, "huntpilot8_link": { "format": "link", "type": "string", "title": "Hunt Pilot" }, "callpark_directed3_link": { "format": "link", "type": "string", "title": "Directed Call Park" }, "line10_link": { "format": "link", "type": "string", "title": "Line (Partition)" }, "huntpilot5_link": { "format": "link", "type": "string", "title": "Hunt Pilot" }, "meetme2_link": { "format": "link", "type": "string", "title": "Meet Me" }, "huntpilot9_link": { "format": "link", "type": "string", "title": "Hunt Pilot" }, "hunt_group2_link": { "format": "link", "type": "string", "title": "Hunt Line Group Member" }, "phone8_link": { "format": "link", "type": "string", "title": "Phone" }, "phone10_link": { "format": "link", "type": "string", "title": "Phone" }, "callpark9_link": { "format": "link", "type": "string", "title": "Call Park" }, "callpark8_link": { "format": "link", "type": "string", "title": "Call Park" } }, "title": "Lsview" }, "extra8": { "type": "string", "title": "Extra8" }, "extra9": { "type": "string", "title": "Extra9" }, "e164number": { "type": "string", "title": "E164Number" }, "extra2": { "type": "string", "title": "Extra2" }, "tag": { "type": "string", "title": "Tag" }, "extra4": { "type": "string", "title": "Extra4" }, "extra5": { "type": "string", "title": "Extra5" }, "extra6": { "type": "string", "title": "Extra6" }, "extra7": { "type": "string", "title": "Extra7" }, "usage": { "type": "string", "title": "Usage" }, "reservation_notes": { "type": "string", "title": "Reservation notes" }, "extra3": { "type": "string", "title": "Extra3" } }, "schema_version": "1.0" }
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/NumberInventoryREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/NumberInventoryREL/[pkid1]", "/api/relation/NumberInventoryREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/NumberInventoryREL/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/NumberInventoryREL |
|
{"hrefs": ["/api/relation/NumberInventoryREL/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=relation/NumberInventoryREL |
|
{"hrefs": ["/api/relation/NumberInventoryREL/[pkid1]", "/api/relation/NumberInventoryREL/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/NumberInventoryREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/NumberInventoryREL/export/ |
|
{ "hrefs":["/api/relation/NumberInventoryREL/[pkid1]", "/api/relation/NumberInventoryREL/[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/NumberInventoryREL and the JSON format can be used to import instances of relation/NumberInventoryREL.
GET http://[host-proxy]/api/relation/NumberInventoryREL/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for relation/NumberInventoryREL | POST | /api/relation/NumberInventoryREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/relation/NumberInventoryREL/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/relation/NumberInventoryREL/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/relation/NumberInventoryREL/ |
|
The relation/NumberInventoryREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/NumberInventoryREL instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "move", "list", "update", "remove", "add", "bulk_update", "export", "ReserveNumber" ], "pagination": { "direction": "asc", "order_by": "internal_number", "maximum_limit": 2000, "skip": 0, "current": "/api/relation/NumberInventoryREL/?skip=0&limit=3&order_by=internal_number&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 1556 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "1.0", "references": { "device": [ { "pkid": "", "href": "" } ], "self": [ { "pkid": null, "href": "/api/relation/NumberInventoryREL/None/" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "remove": { "support_async": true, "class": "delete", "href": "/api/relation/NumberInventoryREL/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/NumberInventoryREL", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/relation/NumberInventoryREL/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/NumberInventoryREL/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/relation/NumberInventoryREL/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/relation/NumberInventoryREL/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/relation/NumberInventoryREL/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/relation/NumberInventoryREL/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "relation/NumberInventoryREL", "model_specific_actions": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "move", "list", "update", "remove", "add", "export", "ReserveNumber" ], "summary_attrs": [ { "name": "internal_number", "title": "Internal Number" }, { "name": "status", "title": "Status" }, { "name": "usage", "title": "Usage" }, { "name": "e164number", "title": "E164Number" }, { "name": "release_date", "title": "Release Date" }, { "name": "tag", "title": "Tag" }, { "name": "description", "title": "Description" }, { "name": "reservation_notes", "title": "Reservation notes" }, { "name": "vendor", "title": "Vendor" }, { "name": "extra1", "title": "Extra1" }, { "name": "extra2", "title": "Extra2" }, { "name": "extra3", "title": "Extra3" }, { "name": "extra4", "title": "Extra4" }, { "name": "extra5", "title": "Extra5" }, { "name": "extra6", "title": "Extra6" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [ { "pkid": "61b13973eadb826afd7d9e45", "meta": { "tags": [], "cached": true, "title": "1000", "business_key": { "hierarchy": true, "unique": [ "internal_number" ] }, "schema_version": "1.8", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "61b13973eadb826afd7d9e45", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e45/" } ], "parent": [ { "pkid": "61b13941eadb826afd7d94c1", "href": "/api/data/HierarchyNode/61b13941eadb826afd7d94c1" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e45/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e45/", "method": "DELETE", "title": "Delete" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/61b13973eadb826afd7d9e45/?model_type=relation/NumberInventoryREL", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e45/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e45/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e45/help", "method": "GET", "title": "Help" } }, { "ReserveNumber": { "support_async": true, "class": "custom", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e45/+ReserveNumber/", "method": "POST", "title": "Reserve Number" } } ], "model_type": "relation/NumberInventoryREL", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b12ed1eadb826afd7b6ddc", "61b13916eadb826afd7d8cd0", "61b1393beadb826afd7d9462", "61b13941eadb826afd7d94c1", "61b13973eadb826afd7d9e45" ], "summary_attrs": [ { "name": "internal_number", "title": "Internal Number" }, { "name": "status", "title": "Status" }, { "name": "usage", "title": "Usage" }, { "name": "e164number", "title": "E164Number" }, { "name": "release_date", "title": "Release Date" }, { "name": "tag", "title": "Tag" }, { "name": "description", "title": "Description" }, { "name": "reservation_notes", "title": "Reservation notes" }, { "name": "vendor", "title": "Vendor" }, { "name": "extra1", "title": "Extra1" }, { "name": "extra2", "title": "Extra2" }, { "name": "extra3", "title": "Extra3" }, { "name": "extra4", "title": "Extra4" }, { "name": "extra5", "title": "Extra5" }, { "name": "extra6", "title": "Extra6" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "status": "Available", "pkid": "61b13973eadb826afd7d9e4a", "internal_number": "1000", "hierarchy_friendly_name": "NorthAnne (Site)", "hierarchy_path": "sys.hcs.CS-P.CS-NB.NBIcorp.North-East-Region.NorthAnne" } }, { "pkid": "61b14ef7eadb826afd80c95a", "meta": { "tags": [], "cached": true, "title": "1001", "business_key": { "hierarchy": true, "unique": [ "internal_number" ] }, "schema_version": "1.8", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "61b14ef7eadb826afd80c95a", "href": "/api/relation/NumberInventoryREL/61b14ef7eadb826afd80c95a/" } ], "parent": [ { "pkid": "61b130c1eadb826afd7bf255", "href": "/api/data/HierarchyNode/61b130c1eadb826afd7bf255" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "href": "/api/relation/NumberInventoryREL/61b14ef7eadb826afd80c95a/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/relation/NumberInventoryREL/61b14ef7eadb826afd80c95a/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/61b14ef7eadb826afd80c95a/?model_type=relation/NumberInventoryREL", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/relation/NumberInventoryREL/61b14ef7eadb826afd80c95a/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "href": "/api/relation/NumberInventoryREL/61b14ef7eadb826afd80c95a/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/relation/NumberInventoryREL/61b14ef7eadb826afd80c95a/help", "title": "Help", "class": "help", "method": "GET" } }, { "ReserveNumber": { "support_async": true, "href": "/api/relation/NumberInventoryREL/61b14ef7eadb826afd80c95a/+ReserveNumber/", "title": "Reserve Number", "class": "custom", "method": "POST" } } ], "model_type": "relation/NumberInventoryREL", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b12ed1eadb826afd7b6ddc", "61b12edfeadb826afd7b715a", "61b130c1eadb826afd7bf255", "61b14ef7eadb826afd80c95a" ], "summary_attrs": [ { "name": "internal_number", "title": "Internal Number" }, { "name": "status", "title": "Status" }, { "name": "usage", "title": "Usage" }, { "name": "e164number", "title": "E164Number" }, { "name": "release_date", "title": "Release Date" }, { "name": "tag", "title": "Tag" }, { "name": "description", "title": "Description" }, { "name": "reservation_notes", "title": "Reservation notes" }, { "name": "vendor", "title": "Vendor" }, { "name": "extra1", "title": "Extra1" }, { "name": "extra2", "title": "Extra2" }, { "name": "extra3", "title": "Extra3" }, { "name": "extra4", "title": "Extra4" }, { "name": "extra5", "title": "Extra5" }, { "name": "extra6", "title": "Extra6" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "status": "Available", "internal_number": "1001", "vendor": "", "description": "", "pkid": "61b14ef7eadb826afd80c95c", "extra1": "", "extra2": "", "tag": "", "extra4": "", "extra5": "", "extra6": "", "usage": "", "reservation_notes": "", "hierarchy_friendly_name": "LOC001 (Site)", "extra3": "", "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal.LOC001" } }, { "pkid": "61b13973eadb826afd7d9e56", "meta": { "tags": [], "cached": true, "title": "1001", "business_key": { "hierarchy": true, "unique": [ "internal_number" ] }, "schema_version": "1.8", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "61b13973eadb826afd7d9e56", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e56/" } ], "parent": [ { "pkid": "61b13941eadb826afd7d94c1", "href": "/api/data/HierarchyNode/61b13941eadb826afd7d94c1" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e56/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e56/", "class": "delete", "title": "Delete" } }, { "move": { "title": "Move", "support_async": true, "method": "POST", "href": "/api/tool/DataMove/61b13973eadb826afd7d9e56/?model_type=relation/NumberInventoryREL", "class": "move", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "method": "GET", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e56/export/", "class": "export", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e56/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e56/help", "class": "help", "title": "Help" } }, { "ReserveNumber": { "support_async": true, "method": "POST", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e56/+ReserveNumber/", "class": "custom", "title": "Reserve Number" } } ], "model_type": "relation/NumberInventoryREL", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b12ed1eadb826afd7b6ddc", "61b13916eadb826afd7d8cd0", "61b1393beadb826afd7d9462", "61b13941eadb826afd7d94c1", "61b13973eadb826afd7d9e56" ], "summary_attrs": [ { "name": "internal_number", "title": "Internal Number" }, { "name": "status", "title": "Status" }, { "name": "usage", "title": "Usage" }, { "name": "e164number", "title": "E164Number" }, { "name": "release_date", "title": "Release Date" }, { "name": "tag", "title": "Tag" }, { "name": "description", "title": "Description" }, { "name": "reservation_notes", "title": "Reservation notes" }, { "name": "vendor", "title": "Vendor" }, { "name": "extra1", "title": "Extra1" }, { "name": "extra2", "title": "Extra2" }, { "name": "extra3", "title": "Extra3" }, { "name": "extra4", "title": "Extra4" }, { "name": "extra5", "title": "Extra5" }, { "name": "extra6", "title": "Extra6" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "status": "Available", "pkid": "61b13973eadb826afd7d9e59", "internal_number": "1001", "hierarchy_friendly_name": "NorthAnne (Site)", "hierarchy_path": "sys.hcs.CS-P.CS-NB.NBIcorp.North-East-Region.NorthAnne" } } ] }
(Show the first instance)
{ "pkid": "61b13973eadb826afd7d9e45", "meta": { "tags": [], "cached": true, "cache_control_policy": "cache_then_device", "title": "1000", "business_key": {}, "schema_version": "1.0", "references": { "device": [ { "pkid": "", "href": "" } ], "self": [ { "pkid": "61b13973eadb826afd7d9e45", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e45/" } ], "children": [], "parent": [ { "pkid": "61b13941eadb826afd7d94c1", "href": "/api/data/HierarchyNode/61b13941eadb826afd7d94c1" } ] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e45/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e45/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/61b13973eadb826afd7d9e45/?hierarchy=[hierarchy]&model_type=relation/NumberInventoryREL", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e45/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e45/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e45/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "ReserveNumber": { "support_async": true, "class": "custom", "href": "/api/relation/NumberInventoryREL/61b13973eadb826afd7d9e45/+ReserveNumber/?hierarchy=[hierarchy]", "method": "POST", "title": "Reserve Number" } } ], "model_type": "relation/NumberInventoryREL", "summary_attrs": [ { "name": "internal_number", "title": "Internal Number" }, { "name": "status", "title": "Status" }, { "name": "usage", "title": "Usage" }, { "name": "e164number", "title": "E164Number" }, { "name": "release_date", "title": "Release Date" }, { "name": "tag", "title": "Tag" }, { "name": "description", "title": "Description" }, { "name": "reservation_notes", "title": "Reservation notes" }, { "name": "vendor", "title": "Vendor" }, { "name": "extra1", "title": "Extra1" }, { "name": "extra2", "title": "Extra2" }, { "name": "extra3", "title": "Extra3" }, { "name": "extra4", "title": "Extra4" }, { "name": "extra5", "title": "Extra5" }, { "name": "extra6", "title": "Extra6" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "status": "Available", "internal_number": "1000" } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for relation/NumberInventoryREL. | GET | /api/relation/NumberInventoryREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/NumberInventoryREL as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/relation/NumberInventoryREL/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/relation/NumberInventoryREL/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/NumberInventoryREL | 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 relation/NumberInventoryREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/NumberInventoryREL/[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/NumberInventoryREL and the JSON format can be used to import instances of relation/NumberInventoryREL.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/relation/NumberInventoryREL/[pkid]/ | hierarchy=[hierarchy] | The relation/NumberInventoryREL instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/relation/NumberInventoryREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/NumberInventoryREL. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Reserve Number | POST | /api/relation/NumberInventoryREL/[pkid]/+ReserveNumber/ | hierarchy=[hierarchy] | If payload required: |