[Index]
Data for site build automation
Model ref.: data/SiteBuild_SiteData_DAT
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": { "defaultDTG": { "required": false, "type": "string", "description": "Select from list of CUCM DTGs", "title": "CUCM TimeZone" }, "extLen": { "required": false, "type": "string", "description": "Select Extension number length (excluding SLC) e.g.6", "title": "Extension Length *" }, "default_cucm_user_serviceprofile": { "required": false, "type": "string", "description": "Select from list of CUCM Service Profiles (if configured)", "title": "CUCM Service Profile" }, "defaultPbt": { "required": false, "type": "string", "description": "Select from list of CUCM phone button templates", "title": "Default Phone Button Template" }, "location_voice_bandwidth": { "required": false, "type": "string", "description": "Set voice bandwidth for Call Access Control", "title": "Location Voice Bandwidth (kbs)" }, "region_intrasite_codec": { "required": false, "type": "string", "description": "Select from list of CUCM codec options", "title": "Intra Site Codec" }, "SiteBuild_Action": { "choices": [ { "value": "AddDataOnly", "title": "AddDataOnly" }, { "value": "Validate", "title": "Validate" }, { "value": "Add", "title": "Add" }, { "value": "Modify", "title": "Modify" }, { "value": "DeleteSite", "title": "DeleteSite" }, { "value": "DeleteSiteData", "title": "DeleteSiteData" }, { "value": "DeleteSiteAndSiteData", "title": "DeleteSiteAndSiteData" }, { "value": "ReprovisionSite", "title": "ReprovisionSite" } ], "required": true, "type": "string", "description": "AddDataOnly, Validate, Add, Modify, Delete", "title": "SiteBuild Action" }, "SiteBuild_LBO_Notes": { "required": false, "type": "string", "description": "Text field for general notes", "title": "LBO Build Notes" }, "SiteBuild_CFT": { "required": true, "type": "string", "description": "Select: From available CFTs starting with SiteBuild_CFT", "title": "Site Build Configuration Template" }, "defaultSkt": { "required": false, "type": "string", "description": "Select from list of CUCM softkey templates", "title": "Default Softkey Template" }, "SiteBuild_LBO_LocalMedia": { "required": false, "type": "boolean", "description": "Enable local media services", "title": "LBO Local Media Services" }, "pilotNumber": { "required": false, "type": "string", "description": "Select from list of available pilot numbers", "title": "Site Pilot Number" }, "updateSteps": { "minItems": 0, "items": { "type": "object", "properties": { "action": { "title": "Action", "type": "string", "description": "Action", "choices": [ { "value": "Add", "title": "Add" }, { "value": "Update", "title": "Update" }, { "value": "Delete", "title": "Delete" } ] }, "attribute": { "required": true, "type": "string", "description": "Changed Attribute", "title": "Changed Attribute" }, "StepName": { "required": true, "type": "string", "description": "Name of Site Build Step Template", "title": "Step Name" }, "StepDescription": { "type": "string", "description": "Function of this step", "title": "Description" } } }, "type": "array", "description": "Update Mappings", "title": "Update Steps" }, "externalID": { "required": false, "type": "string", "description": "Site Billing ID", "title": "External ID" }, "SiteBuild_Name": { "required": true, "type": "string", "description": "Structured name of site (using naming convention)", "title": "SiteBuild Name" }, "devicepool_cucmgroup": { "required": false, "type": "string", "description": "Select from list of CUCM Groups", "title": "DevicePool CUCM Group *" }, "SiteBuild_LBO_IosDeviceName": { "required": false, "type": "string", "description": "IOS Device Name (Max 11 Characters)", "title": "IOS Device Name (Max 11 Characters)" }, "SiteBuild_Status": { "choices": [ { "value": "Pending", "title": "Pending" }, { "value": "Partially Loaded", "title": "Partially Loaded" }, { "value": "Loaded", "title": "Loaded" }, { "value": "Build Started", "title": "Build Started" }, { "value": "Build Completed", "title": "Build Completed" }, { "value": "Operational", "title": "Operational" } ], "required": false, "type": "string", "description": "Select: Pending, Partially Loaded, Loaded, Operational", "title": "Site Activation Status" }, "areaCodeInLocalDialing": { "required": false, "type": "boolean", "description": "Select True if Area Code is required for Local Number Dialling", "title": "Area Code Used for Local Dialing" }, "SiteBuild_ValidData": { "required": false, "type": "boolean", "description": "Result of SiteBuild Validation Check", "title": "Site Build Valid?" }, "city": { "required": false, "type": "string", "description": "Site City", "title": "City *" }, "siteNdlrReference": { "required": false, "type": "string", "description": "Select: Choice of Customer Network Device List", "title": "Network Device List *" }, "SiteBuild_LBO_SipGatewayDescription": { "required": false, "type": "string", "description": "IOS Gateway Description", "title": "SIP Gateway Description" }, "SiteCallPark": { "minItems": 0, "items": { "type": "object", "properties": { "pattern": { "required": false, "type": "string", "description": "Site Call Park Number", "title": "Call Park Number" }, "server": { "required": false, "type": "string", "description": "Site Call Park CUCM Server", "title": "Call Park Server" }, "rangeSize": { "required": false, "type": "string", "description": "Site Call Park Range Size", "title": "Call Park Range Size" }, "description": { "required": false, "type": "string", "description": "Site Call Park Description", "title": "Description" } } }, "type": "array", "description": "Site Call Park Ranges", "title": "Site Call Park Ranges" }, "devicepool_MRGL": { "required": false, "type": "string", "description": "Select from list of CUCM MRGLs", "title": "DevicePool MRGL" }, "SiteBuild_LBO_Local_GatewayIPAddress": { "required": false, "type": "string", "description": "Real IP Address of Gateway", "title": "IOS Gateway Local IP Address" }, "defaultcuclanguage": { "required": false, "type": "string", "description": "Select from list of installed CUC Languages", "title": "CUC Language" }, "default_self_service_language": { "required": false, "type": "string", "description": "Select from list of VOSS Automate Self-Service Languages", "title": "VOSS Automate Self-Service Language" }, "SiteBuild_SRST_Reference": { "required": false, "type": "string", "description": "Gateway SRST Reference Name (if required)", "title": "SRST Reference Name" }, "emerNumber": { "required": false, "type": "string", "description": "Site E164 Emergenct Number e.g. +18585558239 (Must be unique to the site)", "title": "E164 Emergency number" }, "state": { "required": false, "type": "string", "description": "Site State or County", "title": "State" }, "SiteBuild_DialplanActive": { "required": false, "type": "boolean", "description": "Activate Dialplan", "title": "Activate Site Dialplan" }, "site_MOH_SourceName": { "required": false, "type": "string", "description": "Select from list of CUCM MOH Sources", "title": "MOH Source Name" }, "defaultcuctimezone": { "required": false, "type": "string", "description": "Select from list of CUC Timezones", "title": "CUC Timezone" }, "postalCode": { "required": false, "type": "string", "description": "Site ZIP Code or Postal Code", "title": "Postal Code *" }, "voiceMailService": { "required": false, "type": "string", "description": "Select from list of Customer VM Services", "title": "Site VM Service" }, "site_MOH_SourceID": { "required": false, "type": "string", "description": "Select from list of CUCM MOH Sources", "title": "MOH Source ID" }, "pubNumber": { "required": false, "type": "string", "description": "Site E164 Published Number e.g. +18585558230", "title": "E164 Published number" }, "defaultcucsubscribertemplate": { "required": false, "type": "string", "description": "Select using Macro-Evaluate command", "title": "CUC Subscriber Template" }, "region_intersite_codec": { "required": false, "type": "string", "description": "Select from list of CUCM codec options", "title": "Inter Site Codec" }, "streetAddress3": { "required": false, "type": "string", "description": "Site Address Line 3", "title": "Address 3" }, "streetAddress2": { "required": false, "type": "string", "description": "Site Address Line 2", "title": "Address 2" }, "streetAddress1": { "required": false, "type": "string", "description": "Site Address Line 1", "title": "Address 1 *" }, "areaCodeArray": { "minItems": 0, "items": { "type": "object", "properties": { "areaCode": { "required": false, "type": "string", "description": "Select Local Area Code for site e.g. 858", "title": "Area Code" }, "locNumLen": { "required": false, "type": "string", "description": "Select Local Area Code length e.g. 7", "title": "Local Number Length" } } }, "type": "array", "description": "Area Codes", "title": "Area Codes" }, "description": { "required": false, "type": "string", "description": "Site Description", "title": "Description" }, "location_video_bandwidth": { "required": false, "type": "string", "description": "Set video bandwidth for Call Access Control", "title": "Location Video Bandwidth (kbs)" }, "Country": { "required": false, "type": "string", "description": "Select: From data/countries", "title": "Country *" }, "Site": { "minItems": 0, "items": { "type": "object", "properties": { "NumRangeDescription": { "required": false, "type": "string", "description": "Number range description field (added toINI Extra1 field)", "title": "Number Range Description" }, "startNum": { "required": false, "type": "string", "description": "Start of internal number range (must be unique range)", "title": "Starting Extension" }, "RangeSize": { "choices": [ { "value": "1", "title": "1" }, { "value": "10", "title": "10" }, { "value": "100", "title": "100" }, { "value": "1000", "title": "1000" } ], "required": false, "type": "string", "description": "Range block size e.g. 1, 10, 100, 1000", "title": "Range Size" }, "E164Num": { "required": false, "type": "string", "description": "Start of E164 number range (must be unique range)", "title": "Starting E164 Num" } } }, "type": "array", "description": "Site Number Ranges", "title": "Site Number Ranges" }, "defaultNL": { "required": false, "type": "string", "description": "Select from list of CUCM Network Locales", "title": "CUCM Network Locale" }, "defaultUL": { "required": false, "type": "string", "description": "Select from list of CUCM Network Locales", "title": "CUCM User Locale" }, "defaultcuclanguagecallerhears": { "type": "string", "description": "Select from list of options", "title": "Default Language That Callers Hear" }, "SiteBuild_Custom1": { "required": false, "type": "string", "description": "Optional data field for use by SiteBuild CFTs", "title": "Other Site Build Settings 1" }, "extendedName": { "required": false, "type": "string", "description": "Site Long Name", "title": "Extended Name" }, "defaultcucphonesystem": { "required": false, "type": "string", "description": "Select using Macro-Evaluate command", "title": "CUC Phone System" }, "SiteBuild_LBO_SipGatewayName": { "required": false, "type": "string", "description": "SIP Gateway Name", "title": "SIP Gateway Name" }, "SiteDirectedCallPark": { "minItems": 0, "items": { "type": "object", "properties": { "description": { "required": false, "type": "string", "description": "Site Call Park Description", "title": "Description" }, "reversionCss": { "required": false, "type": "string", "description": "Site Directed Call Park Reversion CSS", "title": "Reversion CSS" }, "retrievalPrefix": { "required": false, "type": "string", "description": "Site Directed Call Park Retrieval Prefix", "title": "Retrieval Prefix" }, "pattern": { "required": false, "type": "string", "description": "Site Call Park Number", "title": "Call Park Number" }, "reversionPattern": { "required": false, "type": "string", "description": "Site Directed Call Park Reversion Pattern", "title": "Reversion Pattern" }, "rangeSize": { "required": false, "type": "string", "description": "Site Call Park Range Size", "title": "Call Park Range Size" } } }, "type": "array", "description": "Site Directed Call Park Ranges", "title": "Site Directed Call Park Ranges" }, "useDdiForEmer": { "required": false, "type": "boolean", "description": "Use DDI for emergency calls", "title": "Use DDI for Emergency" }, "default_line_css": { "required": false, "type": "string", "description": "Select from list of CUCM CSSs", "title": "Default Calling Search Space" }, "defaultPhoneProtocol": { "required": false, "type": "string", "description": "Select phone protocol", "title": "Default Phone Protocol" }, "SiteBuild_Type": { "choices": [ { "value": "StandardSite", "title": "StandardSite" }, { "value": "LinkedSite-Parent", "title": "LinkedSite-Parent" }, { "value": "LinkedSite-Child", "title": "LinkedSite-Child" } ], "required": true, "type": "string", "description": "Select: StandardSite, LinkedSite-Parent, LinkedSite-Child", "title": "SiteBuild Type" }, "default_callforward_css": { "required": false, "type": "string", "description": "Select from list of CUCM CSSs", "title": "Default Call Forward Calling Search Space" }, "SiteBuild_LBO_Trunk_CFT": { "required": false, "type": "string", "description": "Select From available CFTs for Trunk Configuration", "title": "LBO Trunk CFT" }, "defaultPhoneType": { "required": false, "type": "string", "description": "Select from list of CUCM phone types", "title": "Default Phone Type" }, "SiteBuildSteps": { "minItems": 1, "items": { "type": "object", "properties": { "StepName": { "required": true, "type": "string", "description": "Name of Site Build Step Template", "title": "Site Build Step Name" }, "StepStatus": { "type": "string", "description": "Result of Site Build Step Execution", "title": "Site Build Step Status" }, "loopThrough": { "type": "string", "description": "Loop through input data", "title": "Loop Through" }, "StepDescription": { "type": "string", "description": "Function of this step", "title": "Description" } } }, "type": "array", "description": "Template Steps to execute", "title": "Site Build Steps" }, "SiteBuild_LBO_IosDeviceDescription": { "required": false, "type": "string", "description": "IOS Gateway Description", "title": "IOS Device Description" }, "SitePUG": { "minItems": 0, "items": { "type": "object", "properties": { "pattern": { "required": false, "type": "string", "description": "Site Call Pickup Group Pilot Number", "title": "Call Pickup Group Number" }, "name": { "required": false, "type": "string", "description": "Site Call Pickup Group Name", "title": "Call Pickup Group Name" }, "description": { "required": false, "type": "string", "description": "Site Call Pickup Group Name Description", "title": "Description" } } }, "type": "array", "description": "Site Pickup Group Numbers", "title": "Site Pickup Group Numbers" }, "SiteBuild_Notes": { "required": false, "type": "string", "description": "Text field for general notes", "title": "Site Build Notes (Text Box)" }, "SiteBuild_Custom2": { "required": false, "type": "string", "description": "Optional data field for use by SiteBuild CFTs", "title": "Other Site Build Settings 2" }, "VM_E164_startNum": { "required": false, "type": "string", "description": "Site-level E164 Pilot number (if required) Must be unique", "title": "E164 Pilot Number (if required)" }, "ext": { "required": false, "type": "string", "description": "Select: 0, 9 (or possible blank or other options)", "title": "External Breakout Number *" }, "default_subscribe_css": { "required": false, "type": "string", "description": "Select from list of CUCM CSSs", "title": "Default Subscribe CSS" }, "linkedSiteParent": { "required": false, "type": "string", "description": "Linked Site Parent. Only required for child sites", "title": "Linked Site Parent (Required for Child Sites)" }, "devicepool_SLRG_Emer_LRG": { "required": false, "type": "string", "description": "Select from list of Route Groups", "title": "SLRG-Emer Local Route Group" }, "slc": { "required": false, "type": "string", "description": "Select unique X-digit SiteLocation for site", "title": "Site Location Code" }, "SiteBuild_LBO_SP_GatewayIPAddress": { "required": false, "type": "string", "description": "IP Address of Gateway in service provider space", "title": "IOS Gateway NAT IP Address" }, "SiteBuild_ValidationMessages": { "required": false, "type": "string", "description": "Result of SiteBuild Validation Check", "title": "Site Build Validation Messages" } }, "schema_version": "0.25" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/SiteBuild_SiteData_DAT/add/ |
|
The GUI Add form of data/SiteBuild_SiteData_DAT 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/SiteBuild_SiteData_DAT | 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/SiteBuild_SiteData_DAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/SiteBuild_SiteData_DAT/[pkid1]", "/api/data/SiteBuild_SiteData_DAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/SiteBuild_SiteData_DAT/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/SiteBuild_SiteData_DAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/SiteBuild_SiteData_DAT/export/ |
|
{ "hrefs":["/api/data/SiteBuild_SiteData_DAT/[pkid1]", "/api/data/SiteBuild_SiteData_DAT/[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/SiteBuild_SiteData_DAT and the JSON format can be used to import instances of data/SiteBuild_SiteData_DAT.
GET http://[host-proxy]/api/data/SiteBuild_SiteData_DAT/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/SiteBuild_SiteData_DAT | POST | /api/data/SiteBuild_SiteData_DAT/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/data/SiteBuild_SiteData_DAT/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/data/SiteBuild_SiteData_DAT/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/SiteBuild_SiteData_DAT/ |
|
The data/SiteBuild_SiteData_DAT schema and all instances as JSON. |
(The list will return 0 to 3 data/SiteBuild_SiteData_DAT instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "list", "update", "remove", "move", "transform", "add", "export", "migration", "bulk_update_form" ], "pagination": { "direction": "asc", "order_by": "SiteBuild_Name", "maximum_limit": 2000, "skip": 0, "current": "/api/data/SiteBuild_SiteData_DAT/?skip=0&limit=3&order_by=SiteBuild_Name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "?", "business_key": { "hierarchy": true, "unique": [ "SiteBuild_Name" ] }, "schema_version": "0.25", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/data/SiteBuild_SiteData_DAT/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/SiteBuild_SiteData_DAT/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/SiteBuild_SiteData_DAT/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/data/SiteBuild_SiteData_DAT/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/data/SiteBuild_SiteData_DAT/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/data/SiteBuild_SiteData_DAT/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/data/SiteBuild_SiteData_DAT/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/SiteBuild_SiteData_DAT/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/SiteBuild_SiteData_DAT", "model_specific_actions": [ "add", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "get", "list", "remove", "update", "help" ], "summary_attrs": [ { "name": "SiteBuild_Name", "title": "SiteBuild Name" }, { "name": "SiteBuild_Action", "title": "SiteBuild Action" }, { "name": "SiteBuild_ValidData", "title": "Site Build Valid?" }, { "name": "SiteBuild_Type", "title": "SiteBuild Type" }, { "name": "SiteBuild_Status", "title": "Site Activation Status" }, { "name": "SiteBuild_DialplanActive", "title": "Activate Site Dialplan" }, { "name": "SiteBuild_CFT", "title": "Site Build Configuration Template" }, { "name": "siteNdlrReference", "title": "Network Device List *" }, { "name": "city", "title": "City *" }, { "name": "Country", "title": "Country *" }, { "name": "slc", "title": "Site Location Code" }, { "name": "extLen", "title": "Extension Length *" }, { "name": "SiteBuild_LBO_IosDeviceName", "title": "IOS Device Name (Max 11 Characters)" }, { "name": "devicepool_cucmgroup", "title": "DevicePool CUCM Group *" }, { "name": "defaultUL", "title": "CUCM User Locale" }, { "name": "defaultDTG", "title": "CUCM TimeZone" }, { "name": "defaultcucsubscribertemplate", "title": "CUC Subscriber Template" }, { "name": "voiceMailService", "title": "Site VM Service" }, { "name": "pilotNumber", "title": "Site Pilot Number" }, { "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 data/SiteBuild_SiteData_DAT. | GET | /api/data/SiteBuild_SiteData_DAT/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/SiteBuild_SiteData_DAT as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/SiteBuild_SiteData_DAT/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/SiteBuild_SiteData_DAT/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/SiteBuild_SiteData_DAT/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/SiteBuild_SiteData_DAT/?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/SiteBuild_SiteData_DAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/SiteBuild_SiteData_DAT/[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/SiteBuild_SiteData_DAT and the JSON format can be used to import instances of data/SiteBuild_SiteData_DAT.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/SiteBuild_SiteData_DAT/[pkid] | hierarchy=[hierarchy] | The data/SiteBuild_SiteData_DAT instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/SiteBuild_SiteData_DAT/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/SiteBuild_SiteData_DAT. |