[Index]
A Data model that is used to store names, codes and dialing number details for countries. This data typically does not change.
Model ref.: data/Countries
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": { "country_name": { "displayable": true, "type": "string", "description": "The ISO country name.", "title": "Country Name" }, "iso_country_code": { "type": "string", "description": "The code by ISO 3166-1.", "title": "ISO Country Code" }, "iso_country_code_short": { "type": "string", "description": "Then short code by ISO 3166-1.", "title": "ISO Country Code (short)" }, "international_dial_code": { "description": "The international dial code for the country. For example, the UK would be 44.", "title": "International Dial Code", "pattern": "^[0-9]*$", "maxLength": 5, "type": "string" }, "international_access_prefix": { "description": "The code used to dial out of the country. For example, in the UK this would be 00.", "title": "International Access Prefix", "pattern": "^[0-9]*$", "maxLength": 5, "type": "string" }, "standard_access_prefix": { "description": "The prefix used when making a standard phone call within the country (i.e. for a call to your neighbor). For example, in the UK this would be 0.", "title": "Standard Access Prefix", "pattern": "^[0-9]*$", "maxLength": 5, "type": "string" }, "premium_access_prefix": { "description": "The prefix used when making a premium call within the country (i.e. for a call to an information service such as weather or news service). For example, in the UK this would be 9.", "title": "Premium Access Prefix", "pattern": "^[0-9]*$", "maxLength": 5, "type": "string" }, "emergency_access_prefix": { "description": "The prefix used when making an emergency call within the country (i.e. for a call to the fire department/service). This is a mandatory field. For example, in the UK this would be 999.", "title": "Emergency Access Prefix", "pattern": "^[0-9]*$", "maxLength": 5, "type": "string" }, "service_access_prefix": { "description": "The prefix used when making a service call within the country (i.e. for a call to your telephone service provider). For example, in the UK this would be 111.", "title": "Service Access Prefix", "pattern": "^[0-9]*$", "maxLength": 5, "type": "string" }, "cli_on_prefix": { "description": "The prefix used within the country when CLI is active.", "title": "CLI On Prefix", "pattern": "^[0-9]*$", "maxLength": 5, "type": "string" }, "national_trunk_prefix": { "description": "The National Trunk Prefix used within the country. For example, in the UK this would be 0.", "title": "National Trunk Prefix", "pattern": "^[0-9]*$", "maxLength": 5, "type": "string" }, "pstn_access_prefix": { "description": "The PSTN Access Prefix used within the country. For example, in the UK this would be 9.", "title": "PSTN Access Prefix", "pattern": "^[0-9]*$", "maxLength": 5, "type": "string" }, "default_user_locale": { "type": "string", "description": "The Default User Locale is used when phones or mobility profiles are bulk loaded, with the phone locale set to 'auto'. If set to 'auto', then the default user locale for the country of the location where the phone or extension mobility profile resides in, is used. The default user locale is also used with the migration from the old phone locale (ISO country code) when the phone locale for a phone or mobility profile is set to 'auto'. In this case, the same selection method as describe above is used.", "title": "Default User Locale" }, "network_locale": { "type": "string", "description": "This contains a definition of the tones and cadences that the phones in the specified user locale will use.", "title": "Network Locale" } }, "schema_version": "0.2.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/Countries/add/ |
|
The GUI Add form of data/Countries 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/data/Countries | 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/data/Countries/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/Countries/[pkid1]", "/api/data/Countries/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/Countries/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/data/Countries/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/data/Countries/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/Countries/[pkid1]", "/api/v0/data/Countries/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/Countries/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/Countries; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/Countries/export/ |
|
{ "hrefs":["/api/data/Countries/[pkid1]", "/api/data/Countries/[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 data/Countries and the JSON format can be used to import instances of data/Countries.
GET http://[host-proxy]/api/data/Countries/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/Countries | POST | /api/data/Countries/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Tag | PATCH | /api/data/Countries/+tag/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Tag Version | PATCH | /api/data/Countries/+tag_version/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/data/Countries/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/data/Countries/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Migration Template | GET | /api/data/Countries/migration/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/Countries/ |
|
The data/Countries schema and all instances as JSON. |
(The list will return 0 to 3 data/Countries instances)
{ "pagination": { "skip": 0, "limit": 3, "maximum_limit": 2000, "total": 78, "total_limit": null, "order_by": "country_name", "direction": "asc", "current": "/api/data/Countries/?skip=0&limit=3&order_by=country_name&direction=asc&traversal=fulltree" }, "operations": [ "field_display_policy", "update", "help", "remove", "move", "add", "export", "list", "configuration_template", "get", "bulk_update_form", "migration", "transform", "export_bulkload_template" ], "meta": { "model_type": "data/Countries", "summary_attrs": [ { "name": "country_name", "title": "Country Name" }, { "name": "iso_country_code", "title": "ISO Country Code" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "", "business_key": { "hierarchy": true, "unique": [ "country_name", "iso_country_code" ] }, "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", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "get", "help", "list", "migration", "remove", "tag", "tag_version", "update" ], "schema_version": "0.2.0", "actions": [ { "add": { "method": "GET", "class": "add", "href": "/api/data/Countries/add/?hierarchy=[hierarchy]", "support_async": false, "title": "Add" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/Countries/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "bulk_update_form": { "method": "GET", "class": "update", "href": "/api/data/Countries/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "support_async": false, "title": "Bulk Modify" } }, { "export": { "method": "POST", "class": "export", "href": "/api/data/Countries/export/?hierarchy=[hierarchy]", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/?auth_token=[authtoken], "submit": "payload" } }, { "export_bulkload_template": { "method": "POST", "class": "bulkload_template", "href": "/api/data/Countries/export_bulkload_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Export Bulk Load Template" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/Countries/+tag/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/Countries/+tag_version/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "method": "GET", "class": "config", "href": "/api/data/Countries/configuration_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Configuration Template" } }, { "field_display_policy": { "method": "GET", "class": "display_policy", "href": "/api/data/Countries/field_display_policy/?hierarchy=[hierarchy]", "support_async": false, "title": "Field Display Policy" } }, { "migration": { "method": "GET", "class": "migration", "href": "/api/data/Countries/migration/?hierarchy=[hierarchy]", "support_async": false, "title": "Migration Template" } }, { "list": { "method": "GET", "class": "list", "href": "/api/data/Countries/?hierarchy=[hierarchy]", "support_async": false, "title": "List" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/Countries/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } } ] }, "resources": [ { "data": { "country_name": "Australia", "iso_country_code": "AUS", "iso_country_code_short": "AU", "international_dial_code": "61", "international_access_prefix": "011", "premium_access_prefix": "8", "emergency_access_prefix": "000", "service_access_prefix": "13", "national_trunk_prefix": "0", "pstn_access_prefix": "9", "default_user_locale": "English United States", "network_locale": "United States", "pkid": "5abb9498affa931ce72a76a2", "hierarchy_friendly_name": "sys (System)", "hierarchy_path": "sys" }, "meta": { "model_type": "data/Countries", "summary_attrs": [ { "name": "country_name", "title": "Country Name" }, { "name": "iso_country_code", "title": "ISO Country Code" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [ "core", "base", "V4UC", "ba_CommonOverlay" ], "title": "Australia - AUS", "business_key": { "hierarchy": true, "unique": [ "country_name", "iso_country_code" ] }, "api_version": "21.2", "cached": true, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [], "self": [ { "href": "/api/data/Countries/5abb9498affa931ce72a76a1/", "pkid": "5abb9498affa931ce72a76a1" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5abb9498affa931ce72a76a1" ], "schema_version": "0.2.0", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/Countries/5abb9498affa931ce72a76a1/", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/Countries/5abb9498affa931ce72a76a1/", "support_async": true, "title": "Delete" } }, { "clone": { "method": "GET", "class": "clone", "href": "/api/data/Countries/5abb9498affa931ce72a76a1/clone/?schema=&schema_rules=true", "support_async": false, "title": "Clone" } }, { "export": { "method": "GET", "class": "export", "href": "/api/data/Countries/5abb9498affa931ce72a76a1/export/", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/", "submit": "payload" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/Countries/5abb9498affa931ce72a76a1/+tag/", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/Countries/5abb9498affa931ce72a76a1/+tag_version/", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/Countries/5abb9498affa931ce72a76a1/", "support_async": false, "title": "Get" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/Countries/5abb9498affa931ce72a76a1/help", "support_async": false, "title": "Help" } } ], "summary": "false" }, "pkid": "5abb9498affa931ce72a76a1" }, { "data": { "country_name": "Australia", "iso_country_code": "AUS", "iso_country_code_short": "AU", "international_dial_code": "61", "international_access_prefix": "0011", "standard_access_prefix": "0", "emergency_access_prefix": "000", "national_trunk_prefix": "0", "pstn_access_prefix": "0", "default_user_locale": "English United States", "network_locale": "Australia", "pkid": "5ad5c01daffa9343e4d94b28", "hierarchy_friendly_name": "hcs (Hcs)", "hierarchy_path": "sys.hcs" }, "meta": { "model_type": "data/Countries", "summary_attrs": [ { "name": "country_name", "title": "Country Name" }, { "name": "iso_country_code", "title": "ISO Country Code" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [ { "pkid": "5ad5c01eaffa9343e4d94b29", "version": "0.5.0.2", "href": "/api/v0/data/Countries/5ad5c01daffa9343e4d94b27/?cached=5ad5c01eaffa9343e4d94b29" } ], "tags": [ "HcsDialPlanAus", "V4UC", "ba_CommonOverlay" ], "title": "Australia - AUS", "business_key": { "hierarchy": true, "unique": [ "country_name", "iso_country_code" ] }, "api_version": "21.2", "cached": true, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "pkid": "5ad5bacbaffa9343e4d93e01", "href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01" } ], "foreign_key": [], "self": [ { "href": "/api/data/Countries/5ad5c01daffa9343e4d94b27/", "pkid": "5ad5c01daffa9343e4d94b27" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "5ad5c01daffa9343e4d94b27" ], "version_tag": "0.5.0.2", "schema_version": "0.2.0", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/Countries/5ad5c01daffa9343e4d94b27/", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/Countries/5ad5c01daffa9343e4d94b27/", "support_async": true, "title": "Delete" } }, { "clone": { "method": "GET", "class": "clone", "href": "/api/data/Countries/5ad5c01daffa9343e4d94b27/clone/?schema=&schema_rules=true", "support_async": false, "title": "Clone" } }, { "export": { "method": "GET", "class": "export", "href": "/api/data/Countries/5ad5c01daffa9343e4d94b27/export/", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/", "submit": "payload" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/Countries/5ad5c01daffa9343e4d94b27/+tag/", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/Countries/5ad5c01daffa9343e4d94b27/+tag_version/", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/Countries/5ad5c01daffa9343e4d94b27/", "support_async": false, "title": "Get" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/Countries/5ad5c01daffa9343e4d94b27/help", "support_async": false, "title": "Help" } } ], "summary": "false" }, "pkid": "5ad5c01daffa9343e4d94b27" }, { "data": { "iso_country_code": "AUT", "pstn_access_prefix": "0", "pkid": "5ae89e67affa931cce38a0ce", "default_user_locale": "English United States", "network_locale": "Austria", "standard_access_prefix": "0", "international_access_prefix": "00", "country_name": "Austria", "international_dial_code": "43", "emergency_access_prefix": "112", "national_trunk_prefix": "0", "hierarchy_friendly_name": "hcs (Hcs)", "hierarchy_path": "sys.hcs" }, "meta": { "model_type": "data/Countries", "summary_attrs": [ { "name": "country_name", "title": "Country Name" }, { "name": "iso_country_code", "title": "ISO Country Code" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "Austria - AUT", "business_key": { "hierarchy": true, "unique": [ "country_name", "iso_country_code" ] }, "api_version": "21.2", "cached": true, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "pkid": "5ad5bacbaffa9343e4d93e01", "href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01" } ], "foreign_key": [], "self": [ { "href": "/api/data/Countries/5ae89e67affa931cce38a0cd/", "pkid": "5ae89e67affa931cce38a0cd" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "5ae89e67affa931cce38a0cd" ], "schema_version": "0.2.0", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/Countries/5ae89e67affa931cce38a0cd/", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/Countries/5ae89e67affa931cce38a0cd/", "support_async": true, "title": "Delete" } }, { "clone": { "method": "GET", "class": "clone", "href": "/api/data/Countries/5ae89e67affa931cce38a0cd/clone/?schema=&schema_rules=true", "support_async": false, "title": "Clone" } }, { "export": { "method": "GET", "class": "export", "href": "/api/data/Countries/5ae89e67affa931cce38a0cd/export/", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/", "submit": "payload" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/Countries/5ae89e67affa931cce38a0cd/+tag/", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/Countries/5ae89e67affa931cce38a0cd/+tag_version/", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/Countries/5ae89e67affa931cce38a0cd/", "support_async": false, "title": "Get" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/Countries/5ae89e67affa931cce38a0cd/help", "support_async": false, "title": "Help" } } ], "summary": "false" }, "pkid": "5ae89e67affa931cce38a0cd" } ] }
(Show the first instance)
{ "data": { "country_name": "Australia", "iso_country_code": "AUS", "iso_country_code_short": "AU", "international_dial_code": "61", "international_access_prefix": "011", "premium_access_prefix": "8", "emergency_access_prefix": "000", "service_access_prefix": "13", "national_trunk_prefix": "0", "pstn_access_prefix": "9", "default_user_locale": "English United States", "network_locale": "United States", "pkid": "5abb9498affa931ce72a76a2" }, "meta": { "model_type": "data/Countries", "summary_attrs": [ { "name": "country_name", "title": "Country Name" }, { "name": "iso_country_code", "title": "ISO Country Code" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [ "core", "base", "V4UC", "ba_CommonOverlay" ], "title": "Australia - AUS", "business_key": { "hierarchy": true, "unique": [ "country_name", "iso_country_code" ] }, "api_version": "21.2", "cached": false, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101", "pkid": "6t0ggef2c0deab00hb595101" } ], "foreign_key": [], "children": [], "self": [ { "href": "/api/data/Countries/5abb9498affa931ce72a76a1/", "pkid": "5abb9498affa931ce72a76a1" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5abb9498affa931ce72a76a1" ], "schema_version": "0.2.0", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/Countries/5abb9498affa931ce72a76a1/?hierarchy=[hierarchy]", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/Countries/5abb9498affa931ce72a76a1/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "clone": { "method": "GET", "class": "clone", "href": "/api/data/Countries/5abb9498affa931ce72a76a1/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "support_async": false, "title": "Clone" } }, { "export": { "method": "GET", "class": "export", "href": "/api/data/Countries/5abb9498affa931ce72a76a1/export/?hierarchy=[hierarchy]", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/?auth_token=[authtoken], "submit": "payload" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/Countries/5abb9498affa931ce72a76a1/+tag/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/Countries/5abb9498affa931ce72a76a1/+tag_version/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/Countries/5abb9498affa931ce72a76a1/?hierarchy=[hierarchy]", "support_async": false, "title": "Get" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/Countries/5abb9498affa931ce72a76a1/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } } ] }, "pkid": "5abb9498affa931ce72a76a1" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/Countries. | GET | /api/data/Countries/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/Countries as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/Countries/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/Countries/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/Countries/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/Countries/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of data/Countries; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/Countries/[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 data/Countries and the JSON format can be used to import instances of data/Countries.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/data/Countries/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/Countries/[pkid] | hierarchy=[hierarchy] | The data/Countries instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/Countries/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/Countries. |