[Index]
Data for Customer build automation
Model ref.: data/CustomerBuild_CustomerData_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": { "streetAddress3": { "required": false, "type": "string", "description": "Customer Address Line 3", "title": "Address 3" }, "azureUsername": { "required": false, "type": "string", "description": "Azure Online (O365) username", "title": "Azure Online username" }, "CustomerBuild_CFT": { "required": true, "type": "string", "description": "Select: From available CFTs starting with CustomerBuild_CFT", "title": "Customer Build Configuration Template" }, "CustomerBuild_Notes": { "required": false, "type": "string", "description": "Text field for general notes", "title": "Customer Build Notes (Text Box)" }, "contactEmail": { "required": false, "type": "string", "description": "Customer Contact Email", "title": "Contact Email" }, "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 Customer 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": "Customer External ID", "title": "External ID" }, "msTeamsAdminDomain": { "required": false, "type": "string", "description": "MS teams Admin Domain", "title": "MS Teams Online Admin Domain" }, "contactName": { "required": false, "type": "string", "description": "Customer Contact Name", "title": "Contact Name" }, "CustomerBuildSteps": { "minItems": 1, "items": { "type": "object", "properties": { "StepName": { "required": true, "type": "string", "description": "Name of Customer Build Step Template", "title": "Customer Build Step Name" }, "StepStatus": { "type": "string", "description": "Result of Customer Build Step Execution", "title": "Customer 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": "Customer Build Steps" }, "CustomerNumber": { "required": false, "type": "string", "description": "Customer Phone Number", "title": "Customer Number" }, "city": { "required": false, "type": "string", "description": "Customer City", "title": "City" }, "msTeamsPassword": { "required": false, "is_password": true, "type": "string", "description": "MS teams password", "title": "MS Teams Online password" }, "CustomerBuild_Type": { "choices": [ { "value": "CiscoCustomer", "title": "CiscoCustomer" }, { "value": "MicrosoftCustomer", "title": "MicrosoftCustomer" }, { "value": "HybridCustomer", "title": "HybridCustomer" }, { "value": "MicrosoftOperatorConnectOnlyCustomer", "title": "MicrosoftOperatorConnectOnlyCustomer" }, { "value": "CallRedirectionOnlyCustomer", "title": "CallRedirectionOnlyCustomer" }, { "value": "Generic", "title": "Generic" } ], "required": true, "type": "string", "description": "Select: StandardCustomer, LinkedCustomer-Parent, LinkedCustomer-Child", "title": "CustomerBuild Type" }, "CustomerBuild_Action": { "choices": [ { "value": "AddDataOnly", "title": "AddDataOnly" }, { "value": "Validate", "title": "Validate" }, { "value": "Add", "title": "Add" }, { "value": "Modify", "title": "Modify" }, { "value": "DeleteCustomer", "title": "DeleteCustomer" }, { "value": "DeletecustomerData", "title": "DeletecustomerData" }, { "value": "DeleteCustomerAndcustomerData", "title": "DeleteCustomerAndcustomerData" }, { "value": "ReprovisionCustomer", "title": "ReprovisionCustomer" } ], "required": true, "type": "string", "description": "AddDataOnly, Validate, Add, Modify, Delete", "title": "CustomerBuild Action" }, "state": { "required": false, "type": "string", "description": "Customer State or County", "title": "State" }, "msTeamsUsername": { "required": false, "type": "string", "description": "MS teams username", "title": "MS Teams Online username" }, "azurePassword": { "required": false, "is_password": true, "type": "string", "description": "Azure Online (O365) password", "title": "Azure Online password" }, "postalCode": { "required": false, "type": "string", "description": "Customer ZIP Code or Postal Code", "title": "Postal Code" }, "CustomerBuild_Custom2": { "required": false, "type": "string", "description": "Optional data field for use by CustomerBuild CFTs", "title": "Other Customer Build Settings 2" }, "CustomerBuild_Custom1": { "required": false, "type": "string", "description": "Optional data field for use by CustomerBuild CFTs", "title": "Other Customer Build Settings 1" }, "CustomerBuild_ValidData": { "required": false, "type": "boolean", "description": "Result of CustomerBuild Validation Check", "title": "Customer Build Valid?" }, "accountID": { "required": false, "type": "string", "description": "Customer Account ID", "title": "Account ID" }, "CustomerBuild_Name": { "required": true, "type": "string", "description": "Structured name of Customer (using naming convention)", "title": "CustomerBuild Name *" }, "streetAddress2": { "required": false, "type": "string", "description": "Customer Address Line 2", "title": "Address 2" }, "streetAddress1": { "required": false, "type": "string", "description": "Customer Address Line 1", "title": "Address 1 *" }, "extPrefix": { "is_password": false, "description": "Specify an optional extension prefix for this customer. Each site can select whether this extension prefix will be required.", "title": "Dial Plan - Extension prefix", "pattern": "^$|^[0-9#*]+$", "required": false, "displayable": false, "readonly": false, "maxLength": 1, "type": "string" }, "description": { "required": false, "type": "string", "description": "Customer Description", "title": "Description" }, "extPrefixRequired": { "required": false, "type": "boolean", "description": "Control Field for extPrefix requirement", "title": "extPrefix Required" }, "Country": { "required": false, "type": "string", "description": "Select: From data/countries", "title": "Country" }, "ecbInstances": { "items": { "type": "object", "properties": { "ecbInstance": { "type": "string", "description": "ECB Instance", "title": "ECB Instance" } } }, "type": "array", "description": "ECB Instances", "title": "ECB Instances" }, "cb_dp_cft": { "required": false, "type": "string", "description": "Customer Dialplan CFT", "title": "Customer Dialplan CFT" }, "CustomerBuild_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": "Customer Activation Status" }, "extendedName": { "required": false, "type": "string", "description": "Customer Long Name", "title": "Extended Name" }, "client_id": { "type": "string", "title": "Client ID" }, "client_secret": { "is_password": true, "type": "string", "description": "A Client (application) Secret, either a password or a public/private key pair (certificate).", "title": "Secret" }, "shortName": { "required": false, "type": "string", "description": "Customer Short Name", "title": "Short Name" }, "webexAppName": { "required": false, "type": "string", "description": "Webex App Name", "title": "Webex App Name" }, "sbcInstances": { "items": { "type": "object", "properties": { "sbcInstance": { "type": "string", "description": "SBC Instance", "title": "SBC Instance" } } }, "type": "array", "description": "SBC Instances", "title": "SBC Instances" }, "tenant_description": { "required": false, "type": "string", "description": "Microsoft Tenant Description", "title": "Microsoft Tenant Description" }, "CustomerBuild_ValidationMessages": { "required": false, "type": "string", "description": "Result of CustomerBuild Validation Check", "title": "Customer Build Validation Messages" }, "displayName": { "required": false, "type": "string", "description": "Customer Display Name", "title": "Display Name" }, "internalID": { "required": false, "type": "string", "description": "Customer Internal ID", "title": "Internal ID" }, "deleteSteps": { "minItems": 0, "items": { "type": "object", "properties": { "StepName": { "required": true, "type": "string", "description": "Name of Delete Step Template", "title": "Delete Step Name" }, "StepStatus": { "type": "string", "description": "Result of Delete Step Execution", "title": "Delete 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": "Delete Mappings", "title": "Delete Steps" }, "tenant_id": { "type": "string", "title": "Tenant ID" }, "uccxInstances": { "items": { "type": "object", "properties": { "username": { "required": false, "type": "string", "description": "UCCX Username", "title": "Username" }, "password": { "required": false, "is_password": true, "type": "string", "description": "UCCX Password", "title": "Password" }, "host": { "required": false, "type": "string", "description": "UCCX Host", "title": "Host" }, "version": { "required": false, "type": "string", "description": "UCCX Version", "title": "Version" }, "name": { "required": false, "type": "string", "description": "UCCX Name", "title": "Name" } } }, "type": "array", "description": "UCCX Instances", "title": "UCCX Instances" }, "isp": { "is_password": false, "description": "Inter-site prefix if ISP required for inter-site dialing.", "title": "Dial Plan - Inter-Site Prefix", "pattern": "^$|^[0-9]+$", "required": false, "displayable": false, "readonly": false, "maxLength": 1, "type": "string" }, "cucmInstances": { "items": { "type": "object", "properties": { "username": { "required": false, "type": "string", "description": "CUCM Username", "title": "Username" }, "name": { "required": false, "type": "string", "description": "CUCM Name", "title": "Name" }, "clusterName": { "required": false, "type": "string", "description": "CUCM Cluster Name", "title": "Cluster Name" }, "isUCPublisher": { "required": false, "type": "string", "description": "Is UC Publisher", "title": "Is UC Publisher" }, "host": { "required": false, "type": "string", "description": "CUCM Host", "title": "Host" }, "version": { "required": false, "type": "string", "description": "CUCM Version", "title": "Version" }, "password": { "required": false, "is_password": true, "type": "string", "description": "CUCM Password", "title": "Password" }, "port": { "required": false, "type": "string", "description": "CUCM Port", "title": "Port" } } }, "type": "array", "description": "CUCM Instances", "title": "CUCM Instances" }, "ispRequired": { "required": false, "type": "boolean", "description": "Control Field for ISP requirement", "title": "ISP Required" }, "msTenantName": { "required": false, "type": "string", "description": "Microsoft Tenant Name", "title": "Microsoft Tenant Name" }, "msPsProxyAddress": { "required": false, "type": "string", "description": "IP Address/FQDN of the Powershell proxy", "title": "Microsoft Powershell Proxy Address" }, "msPsProxyUsername": { "required": false, "type": "string", "description": "Powershell proxy username", "title": "Microsoft Powershell Proxy Username" }, "webexAppAccountNumber": { "required": false, "type": "string", "description": "Webex App Account Number", "title": "Webex App Account Number" }, "numberRanges": { "items": { "type": "object", "properties": { "numberRange": { "type": "string", "description": "E164 Number or Range using X wildcards", "title": "Number Range" }, "ocUsageTemplate": { "type": "string", "description": "Microsoft Operator connect usage template", "title": "Operator Connect Usage Template" }, "translatedNumber": { "type": "string", "description": "Number to translate to", "title": "Translated Number" } } }, "type": "array", "description": "E164 Number Ranges", "title": "Number Ranges" }, "cucInstances": { "items": { "type": "object", "properties": { "username": { "required": false, "type": "string", "description": "CUC Username", "title": "Username" }, "name": { "required": false, "type": "string", "description": "CUC Name", "title": "Name" }, "clusterName": { "required": false, "type": "string", "description": "CUC Cluster Name", "title": "Cluster Name" }, "host": { "required": false, "type": "string", "description": "CUC Host", "title": "Host" }, "version": { "required": false, "type": "string", "description": "CUC Version", "title": "Version" }, "password": { "required": false, "is_password": true, "type": "string", "description": "CUC Password", "title": "Password" } } }, "type": "array", "description": "CUC Instances", "title": "CUC Instances" }, "msPsProxyPassword": { "required": false, "is_password": true, "type": "string", "description": "Powershell proxy password", "title": "Microsoft Powershell Proxy password" } }, "schema_version": "1.5" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/CustomerBuild_CustomerData_DAT/add/ |
|
The GUI Add form of data/CustomerBuild_CustomerData_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/CustomerBuild_CustomerData_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/CustomerBuild_CustomerData_DAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/CustomerBuild_CustomerData_DAT/[pkid1]", "/api/data/CustomerBuild_CustomerData_DAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/CustomerBuild_CustomerData_DAT/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/CustomerBuild_CustomerData_DAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/CustomerBuild_CustomerData_DAT/export/ |
|
{ "hrefs":["/api/data/CustomerBuild_CustomerData_DAT/[pkid1]", "/api/data/CustomerBuild_CustomerData_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/CustomerBuild_CustomerData_DAT and the JSON format can be used to import instances of data/CustomerBuild_CustomerData_DAT.
GET http://[host-proxy]/api/data/CustomerBuild_CustomerData_DAT/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/CustomerBuild_CustomerData_DAT | POST | /api/data/CustomerBuild_CustomerData_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/CustomerBuild_CustomerData_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/CustomerBuild_CustomerData_DAT/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/CustomerBuild_CustomerData_DAT/ |
|
The data/CustomerBuild_CustomerData_DAT schema and all instances as JSON. |
(The list will return 0 to 3 data/CustomerBuild_CustomerData_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": "CustomerBuild_Name", "maximum_limit": 2000, "skip": 0, "current": "/api/data/CustomerBuild_CustomerData_DAT/?skip=0&limit=3&order_by=CustomerBuild_Name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "?", "business_key": { "hierarchy": true, "unique": [ "CustomerBuild_Name" ] }, "schema_version": "1.5", "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/CustomerBuild_CustomerData_DAT/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/CustomerBuild_CustomerData_DAT/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/CustomerBuild_CustomerData_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/CustomerBuild_CustomerData_DAT/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/data/CustomerBuild_CustomerData_DAT/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/data/CustomerBuild_CustomerData_DAT/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/data/CustomerBuild_CustomerData_DAT/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/CustomerBuild_CustomerData_DAT/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/CustomerBuild_CustomerData_DAT", "model_specific_actions": [ "add", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "get", "list", "remove", "update", "help" ], "summary_attrs": [ { "name": "CustomerBuild_Name", "title": "CustomerBuild Name *" }, { "name": "CustomerBuild_Action", "title": "CustomerBuild Action" }, { "name": "CustomerBuild_ValidData", "title": "Customer Build Valid?" }, { "name": "CustomerBuild_Type", "title": "CustomerBuild Type" }, { "name": "CustomerBuild_Status", "title": "Customer Activation Status" }, { "name": "CustomerBuild_CFT", "title": "Customer Build Configuration Template" }, { "name": "city", "title": "City" }, { "name": "Country", "title": "Country" }, { "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/CustomerBuild_CustomerData_DAT. | GET | /api/data/CustomerBuild_CustomerData_DAT/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/CustomerBuild_CustomerData_DAT as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/CustomerBuild_CustomerData_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/CustomerBuild_CustomerData_DAT/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/CustomerBuild_CustomerData_DAT/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/CustomerBuild_CustomerData_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/CustomerBuild_CustomerData_DAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/CustomerBuild_CustomerData_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/CustomerBuild_CustomerData_DAT and the JSON format can be used to import instances of data/CustomerBuild_CustomerData_DAT.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/CustomerBuild_CustomerData_DAT/[pkid] | hierarchy=[hierarchy] | The data/CustomerBuild_CustomerData_DAT instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/CustomerBuild_CustomerData_DAT/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/CustomerBuild_CustomerData_DAT. |