[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": { "relation_HcsNetworkDeviceListREL": { "items": { "type": "object", "properties": { "shadow": { "items": { "type": "object", "properties": { "name": { "is_password": false, "title": "Name", "required": true, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" } } }, "type": "array", "maxItems": 1, "title": "Shadow" }, "name": { "is_password": false, "description": "Name of the list of network devices.", "title": "Name", "items": { "is_password": false }, "required": true, "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": { "OracleSBC": { "description": "A list of OracleSBC references", "title": "OracleSBC", "items": { "target": "/api/data/OracleSBC/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the OracleSBC", "required": true, "choices": [], "readonly": false, "target_model_type": "data/OracleSBC", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "msonline": { "description": "A list of Microsoft Online references", "title": "Microsoft Online", "items": { "target": "/api/data/msonline/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the Microsoft Online", "required": true, "choices": [], "readonly": false, "target_model_type": "data/msonline", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "exchangehybrid": { "description": "A list of Exchange Hybrid references", "title": "Exchange Hybrid", "items": { "target": "/api/data/exchangehybrid/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the Exchange Hybrid", "required": true, "choices": [], "readonly": false, "target_model_type": "data/exchangehybrid", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "CallManager": { "description": "A list of Cisco Unified CM references", "title": "Cisco Unified CM", "items": { "target": "/api/data/CallManager/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the Cisco Unified CM", "required": true, "choices": [], "readonly": false, "target_model_type": "data/CallManager", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "activedirectoryhybrid": { "description": "A list of Active Directory Hybrid references", "title": "Active Directory Hybrid", "items": { "target": "/api/data/activedirectoryhybrid/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the Active Directory Hybrid", "required": true, "choices": [], "readonly": false, "target_model_type": "data/activedirectoryhybrid", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "OracleECB": { "description": "A list of OracleECB references", "title": "OracleECB", "items": { "target": "/api/data/OracleECB/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the OracleECB", "required": true, "choices": [], "readonly": false, "target_model_type": "data/OracleECB", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "GuiCucm": { "description": "A list of CallManager GUI references", "title": "CallManager GUI", "items": { "target": "/api/data/GuiCucm/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the CallManager GUI", "required": true, "choices": [], "readonly": false, "target_model_type": "data/GuiCucm", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "Ldap": { "description": "A list of LDAP references", "title": "LDAP", "items": { "target": "/api/data/Ldap/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the LDAP", "required": true, "choices": [], "readonly": false, "target_model_type": "data/Ldap", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "MSTeamsOnline": { "description": "A list of MSTeamsOnline references", "title": "MSTeamsOnline", "items": { "target": "/api/data/MSTeamsOnline/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the MSTeamsOnline", "required": true, "choices": [], "readonly": false, "target_model_type": "data/MSTeamsOnline", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "MSOperatorConnect": { "description": "A list of MSOperatorConnect references", "title": "MSOperatorConnect", "items": { "target": "/api/data/MSOperatorConnect/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the MSOperatorConnect", "required": true, "choices": [], "readonly": false, "target_model_type": "data/MSOperatorConnect", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "Ios": { "description": "A list of IOS references", "title": "IOS", "items": { "target": "/api/data/Ios/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the IOS", "required": true, "choices": [], "readonly": false, "target_model_type": "data/Ios", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "snow": { "description": "A list of Service Now references", "title": "Service Now", "items": { "target": "/api/data/snow/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the Service Now", "required": true, "choices": [], "readonly": false, "target_model_type": "data/snow", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "Roomos": { "description": "A list of Roomos references", "title": "Roomos", "items": { "target": "/api/data/Roomos/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the Roomos", "required": true, "choices": [], "readonly": false, "target_model_type": "data/Roomos", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "MSExchangeOnline": { "description": "A list of MSExchangeOnline references", "title": "MSExchangeOnline", "items": { "target": "/api/data/MSExchangeOnline/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the MSExchangeOnline", "required": true, "choices": [], "readonly": false, "target_model_type": "data/MSExchangeOnline", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "Hcmf": { "description": "A list of Cisco HCM-F references", "title": "Cisco HCM-F", "items": { "target": "/api/data/Hcmf/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the Cisco HCM-F", "required": true, "choices": [], "readonly": false, "target_model_type": "data/Hcmf", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "AssuranceArbitrator": { "description": "A list of Assurance Arbitrator references", "title": "Assurance Arbitrator", "items": { "target": "/api/data/AssuranceArbitrator/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the Assurance Arbitrator", "required": true, "choices": [], "readonly": false, "target_model_type": "data/AssuranceArbitrator", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "skypeforbusinessonline": { "description": "A list of SkypeForBusiness Online references", "title": "SkypeForBusiness Online", "items": { "target": "/api/data/skypeforbusinessonline/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the SkypeForBusiness Online", "required": true, "choices": [], "readonly": false, "target_model_type": "data/skypeforbusinessonline", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "CmCcs": { "description": "A list of Call Manager Control Center Services references", "title": "Call Manager Control Center Services", "items": { "target": "/api/data/CmCcs/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the Call Manager Control Center Services", "required": true, "choices": [], "readonly": false, "target_model_type": "data/CmCcs", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "Imap": { "description": "A list of IMAP4 references", "title": "IMAP4", "items": { "target": "/api/data/Imap/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the IMAP4", "required": true, "choices": [], "readonly": false, "target_model_type": "data/Imap", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "Sfb2015": { "description": "A list of sfb2015 references", "title": "sfb2015", "items": { "target": "/api/data/Sfb2015/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the sfb2015", "required": true, "choices": [], "readonly": false, "target_model_type": "data/Sfb2015", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "skypeforbusinesshybrid": { "description": "A list of SkypeForBusiness Hybrid references", "title": "SkypeForBusiness Hybrid", "items": { "target": "/api/data/skypeforbusinesshybrid/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the SkypeForBusiness Hybrid", "required": true, "choices": [], "readonly": false, "target_model_type": "data/skypeforbusinesshybrid", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "exchange": { "description": "A list of Exchange references", "title": "Exchange", "items": { "target": "/api/data/exchange/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the Exchange", "required": true, "choices": [], "readonly": false, "target_model_type": "data/exchange", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "activedirectory": { "description": "A list of Active Directory references", "title": "Active Directory", "items": { "target": "/api/data/activedirectory/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the Active Directory", "required": true, "choices": [], "readonly": false, "target_model_type": "data/activedirectory", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "UnityConnection": { "description": "A list of Cisco Unity Connection references", "title": "Cisco Unity Connection", "items": { "target": "/api/data/UnityConnection/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the Cisco Unity Connection", "required": true, "choices": [], "readonly": false, "target_model_type": "data/UnityConnection", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "AudioCodes": { "description": "A list of AudioCodes references", "title": "AudioCodes", "items": { "target": "/api/data/AudioCodes/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the AudioCodes", "required": true, "choices": [], "readonly": false, "target_model_type": "data/AudioCodes", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "GuiCuc": { "description": "A list of Unity Connection GUI references", "title": "Unity Connection GUI", "items": { "target": "/api/data/GuiCuc/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the Unity Connection GUI", "required": true, "choices": [], "readonly": false, "target_model_type": "data/GuiCuc", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "MSGraph": { "description": "A list of MSGraph references", "title": "MSGraph", "items": { "target": "/api/data/MSGraph/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the MSGraph", "required": true, "choices": [], "readonly": false, "target_model_type": "data/MSGraph", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "exchangeonline": { "description": "A list of Exchange Online references", "title": "Exchange Online", "items": { "target": "/api/data/exchangeonline/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the Exchange Online", "required": true, "choices": [], "readonly": false, "target_model_type": "data/exchangeonline", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "Uccx": { "description": "A list of Cisco Unified Contact Center Express references", "title": "Cisco Unified Contact Center Express", "items": { "target": "/api/data/Uccx/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the Cisco Unified Contact Center Express", "required": true, "choices": [], "readonly": false, "target_model_type": "data/Uccx", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "skypeforbusiness": { "description": "A list of SkypeForBusiness references", "title": "SkypeForBusiness", "items": { "target": "/api/data/skypeforbusiness/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the SkypeForBusiness", "required": true, "choices": [], "readonly": false, "target_model_type": "data/skypeforbusiness", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "AzureADOnline": { "description": "A list of AzureADOnline references", "title": "AzureADOnline", "items": { "target": "/api/data/AzureADOnline/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the AzureADOnline", "required": true, "choices": [], "readonly": false, "target_model_type": "data/AzureADOnline", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "GuiImp": { "description": "A list of IMP GUI references", "title": "IMP GUI", "items": { "target": "/api/data/GuiImp/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the IMP GUI", "required": true, "choices": [], "readonly": false, "target_model_type": "data/GuiImp", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "Smtp": { "description": "A list of SMTP references", "title": "SMTP", "items": { "target": "/api/data/Smtp/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the SMTP", "required": true, "choices": [], "readonly": false, "target_model_type": "data/Smtp", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "Pgw": { "description": "A list of PGW references", "title": "PGW", "items": { "target": "/api/data/Pgw/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the PGW", "required": true, "choices": [], "readonly": false, "target_model_type": "data/Pgw", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "WebEx": { "description": "A list of Cisco WebEx references", "title": "Cisco WebEx", "items": { "target": "/api/data/WebEx/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the Cisco WebEx", "required": true, "choices": [], "readonly": false, "target_model_type": "data/WebEx", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "GenericCucm": { "description": "A list of Call Manager AXL Generic Driver references", "title": "Call Manager AXL Generic Driver", "items": { "target": "/api/data/GenericCucm/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the Call Manager AXL Generic Driver", "required": true, "choices": [], "readonly": false, "target_model_type": "data/GenericCucm", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" }, "powershell": { "description": "A list of PowerShell references", "title": "PowerShell", "items": { "target": "/api/data/powershell/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "description": "Reference to the PowerShell", "required": true, "choices": [], "readonly": false, "target_model_type": "data/powershell", "type": "string", "name": "reference" }, "required": false, "readonly": false, "type": "array" } } }, "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" } } }, "type": "array", "maxItems": 1, "title": "Relation Hcs Network Device List Rel" }, "name": { "is_password": false, "title": "Name", "required": true, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" } } }
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)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "list", "update", "remove", "add", "bulk_update", "export" ], "pagination": { "direction": "asc", "order_by": "name", "maximum_limit": 2000, "skip": 0, "current": "/api/relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": null, "references": { "device": [ { "pkid": "", "href": "" } ], "self": [ { "pkid": null, "href": "/api/relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL/None/" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "list": { "support_async": false, "class": "list", "href": "/api/relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } } ], "model_type": "relation/CustomerBuild-AddCiscoCustomerNDL-WFC_REL", "model_specific_actions": [ "add", "export", "get", "export_bulkload_template", "list", "update", "remove" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "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]. |