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