[Index]
CustomerBuild-AddCiscoCustomerNDL-WFC_REL
Model ref.: relation/CustomerBuild-AddCiscoCustomerNDL-WFC_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": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"relation_HcsNetworkDeviceListREL": {
"title": "Relation Hcs Network Device List Rel",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"description": "Name of the list of network devices.",
"title": "Name",
"items": {
"is_password": false
},
"required": true,
"readonly": false,
"type": "string"
},
"description": {
"is_password": false,
"description": "The description of the the network device list instance.",
"title": "Description",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"devices": {
"is_password": false,
"description": "Devices owned by the entity. The entity can be for example a Customer or Service provider.",
"title": "Devices",
"required": false,
"readonly": false,
"type": "object",
"properties": {
"activedirectory": {
"description": "A list of Active Directory references",
"title": "Active Directory",
"items": {
"description": "Reference to the Active Directory",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/activedirectory/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/activedirectory",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"activedirectoryhybrid": {
"description": "A list of Active Directory Hybrid references",
"title": "Active Directory Hybrid",
"items": {
"description": "Reference to the Active Directory Hybrid",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/activedirectoryhybrid/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/activedirectoryhybrid",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"AssuranceArbitrator": {
"description": "A list of Assurance Arbitrator references",
"title": "Assurance Arbitrator",
"items": {
"description": "Reference to the Assurance Arbitrator",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/AssuranceArbitrator/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/AssuranceArbitrator",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"AudioCodes": {
"description": "A list of AudioCodes references",
"title": "AudioCodes",
"items": {
"description": "Reference to the AudioCodes",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/AudioCodes/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/AudioCodes",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"AzureADOnline": {
"description": "A list of AzureADOnline references",
"title": "AzureADOnline",
"items": {
"description": "Reference to the AzureADOnline",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/AzureADOnline/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/AzureADOnline",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"BroadsoftOCIP": {
"description": "A list of BroadsoftOCIP references",
"title": "BroadsoftOCIP",
"items": {
"description": "Reference to the BroadsoftOCIP",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/BroadsoftOCIP/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/BroadsoftOCIP",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"GenericCucm": {
"description": "A list of Call Manager AXL Generic Driver references",
"title": "Call Manager AXL Generic Driver",
"items": {
"description": "Reference to the Call Manager AXL Generic Driver",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/GenericCucm/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/GenericCucm",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"CmCcs": {
"description": "A list of Call Manager Control Center Services references",
"title": "Call Manager Control Center Services",
"items": {
"description": "Reference to the Call Manager Control Center Services",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/CmCcs/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/CmCcs",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"GuiCucm": {
"description": "A list of CallManager GUI references",
"title": "CallManager GUI",
"items": {
"description": "Reference to the CallManager GUI",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/GuiCucm/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/GuiCucm",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"Hcmf": {
"description": "A list of Cisco HCM-F references",
"title": "Cisco HCM-F",
"items": {
"description": "Reference to the Cisco HCM-F",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/Hcmf/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/Hcmf",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"CallManager": {
"description": "A list of Cisco Unified CM references",
"title": "Cisco Unified CM",
"items": {
"description": "Reference to the Cisco Unified CM",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/CallManager/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/CallManager",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"Uccx": {
"description": "A list of Cisco Unified Contact Center Express references",
"title": "Cisco Unified Contact Center Express",
"items": {
"description": "Reference to the Cisco Unified Contact Center Express",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/Uccx/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/Uccx",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"UnityConnection": {
"description": "A list of Cisco Unity Connection references",
"title": "Cisco Unity Connection",
"items": {
"description": "Reference to the Cisco Unity Connection",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/UnityConnection/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/UnityConnection",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"WebEx": {
"description": "A list of Cisco WebEx references",
"title": "Cisco WebEx",
"items": {
"description": "Reference to the Cisco WebEx",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/WebEx/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/WebEx",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"exchange": {
"description": "A list of Exchange references",
"title": "Exchange",
"items": {
"description": "Reference to the Exchange",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/exchange/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/exchange",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"exchangehybrid": {
"description": "A list of Exchange Hybrid references",
"title": "Exchange Hybrid",
"items": {
"description": "Reference to the Exchange Hybrid",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/exchangehybrid/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/exchangehybrid",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"exchangeonline": {
"description": "A list of Exchange Online references",
"title": "Exchange Online",
"items": {
"description": "Reference to the Exchange Online",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/exchangeonline/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/exchangeonline",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"Imap": {
"description": "A list of IMAP4 references",
"title": "IMAP4",
"items": {
"description": "Reference to the IMAP4",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/Imap/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/Imap",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"GuiImp": {
"description": "A list of IMP GUI references",
"title": "IMP GUI",
"items": {
"description": "Reference to the IMP GUI",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/GuiImp/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/GuiImp",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"Ios": {
"description": "A list of IOS references",
"title": "IOS",
"items": {
"description": "Reference to the IOS",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/Ios/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/Ios",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"Ldap": {
"description": "A list of LDAP references",
"title": "LDAP",
"items": {
"description": "Reference to the LDAP",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/Ldap/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/Ldap",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"MSExchangeOnline": {
"description": "A list of MSExchangeOnline references",
"title": "MSExchangeOnline",
"items": {
"description": "Reference to the MSExchangeOnline",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/MSExchangeOnline/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/MSExchangeOnline",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"MSGraph": {
"description": "A list of MSGraph references",
"title": "MSGraph",
"items": {
"description": "Reference to the MSGraph",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/MSGraph/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/MSGraph",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"MSOperatorConnect": {
"description": "A list of MSOperatorConnect references",
"title": "MSOperatorConnect",
"items": {
"description": "Reference to the MSOperatorConnect",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/MSOperatorConnect/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/MSOperatorConnect",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"MSTeamsOnline": {
"description": "A list of MSTeamsOnline references",
"title": "MSTeamsOnline",
"items": {
"description": "Reference to the MSTeamsOnline",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/MSTeamsOnline/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/MSTeamsOnline",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"msonline": {
"description": "A list of Microsoft Online references",
"title": "Microsoft Online",
"items": {
"description": "Reference to the Microsoft Online",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/msonline/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/msonline",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"OracleECB": {
"description": "A list of OracleECB references",
"title": "OracleECB",
"items": {
"description": "Reference to the OracleECB",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/OracleECB/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/OracleECB",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"OracleSBC": {
"description": "A list of OracleSBC references",
"title": "OracleSBC",
"items": {
"description": "Reference to the OracleSBC",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/OracleSBC/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/OracleSBC",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"Pgw": {
"description": "A list of PGW references",
"title": "PGW",
"items": {
"description": "Reference to the PGW",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/Pgw/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/Pgw",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"powershell": {
"description": "A list of PowerShell references",
"title": "PowerShell",
"items": {
"description": "Reference to the PowerShell",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/powershell/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/powershell",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"Roomos": {
"description": "A list of Roomos references",
"title": "Roomos",
"items": {
"description": "Reference to the Roomos",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/Roomos/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/Roomos",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"Smtp": {
"description": "A list of SMTP references",
"title": "SMTP",
"items": {
"description": "Reference to the SMTP",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/Smtp/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/Smtp",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"snow": {
"description": "A list of Service Now references",
"title": "Service Now",
"items": {
"description": "Reference to the Service Now",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/snow/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/snow",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"skypeforbusiness": {
"description": "A list of SkypeForBusiness references",
"title": "SkypeForBusiness",
"items": {
"description": "Reference to the SkypeForBusiness",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/skypeforbusiness/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/skypeforbusiness",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"skypeforbusinesshybrid": {
"description": "A list of SkypeForBusiness Hybrid references",
"title": "SkypeForBusiness Hybrid",
"items": {
"description": "Reference to the SkypeForBusiness Hybrid",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/skypeforbusinesshybrid/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/skypeforbusinesshybrid",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"skypeforbusinessonline": {
"description": "A list of SkypeForBusiness Online references",
"title": "SkypeForBusiness Online",
"items": {
"description": "Reference to the SkypeForBusiness Online",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/skypeforbusinessonline/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/skypeforbusinessonline",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"GuiCuc": {
"description": "A list of Unity Connection GUI references",
"title": "Unity Connection GUI",
"items": {
"description": "Reference to the Unity Connection GUI",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/GuiCuc/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/GuiCuc",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
},
"Sfb2015": {
"description": "A list of sfb2015 references",
"title": "sfb2015",
"items": {
"description": "Reference to the sfb2015",
"format": "uri",
"required": true,
"name": "reference",
"readonly": false,
"type": "string",
"target": "/api/data/Sfb2015/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/Sfb2015",
"choices": []
},
"required": false,
"readonly": false,
"type": "array"
}
}
},
"shadow": {
"title": "Shadow",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"maxLength": 1024,
"required": true,
"readonly": false,
"is_password": false,
"displayable": false
}
}
},
"maxItems": 1
}
}
},
"maxItems": 1
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL/add/ |
|
The GUI Add form of relation/CustomerBuild-AddCiscoCustomerNDL-WFC_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/CustomerBuild-AddCiscoCustomerNDL-WFC_REL | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL | POST | /api/relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL/ |
|
The relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL schema and all instances as JSON. |
(The list will return 0 to 3 relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL/?skip=0&limit=3&order_by=name&direction=asc&traversal=fulltree"
},
"operations": [
"list",
"help",
"field_display_policy",
"get",
"configuration_template",
"update",
"bulk_update",
"export",
"add",
"remove",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"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/CustomerBuild-AddCiscoCustomerNDL-WFC_REL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"list",
"update",
"remove",
"add",
"export",
"export_bulkload_template",
"get"
],
"schema_version": null,
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL/[pkid] | hierarchy=[hierarchy] | The relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL instance with [pkid]. |