[Index]
CustomerBuild-AddCiscoCustomer-WFC_REL
Model ref.: relation/CustomerBuild-AddCiscoCustomer-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_HcsCustomerREL": {
"title": "Relation Hcs Customer Rel",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"description": "Customer's name",
"title": "Name",
"pattern": "^[A-Za-z0-9_\\- ]+$",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 64,
"type": "string"
},
"directoryDomain": {
"is_password": false,
"description": "Customer's directory domain name",
"title": "Directory Domain",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"shared_uc_apps": {
"is_password": false,
"description": "Indicates whether the Customer shares UC Application instances",
"title": "Shared UC Applications",
"default": "false",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"create_admin": {
"is_password": false,
"description": "Indiates whether or not an Admin User should be created",
"title": "Create Local Admin",
"default": "true",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"HierarchyPath": {
"is_password": false,
"description": "Customer entity's hierarchy",
"title": "Hierarchy Path",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"migrate": {
"is_password": false,
"description": "Migrate HCM-F Models to CUCDM Models",
"title": "Migrate from HCM-F to CUCDM",
"default": "false",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"disableNumMgmt": {
"is_password": false,
"description": "Disables number management",
"title": "Disable Number Management",
"default": "false",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"publicSector": {
"default": "false",
"type": "boolean",
"title": "Public Sector"
},
"inactiveBilling": {
"default": "false",
"type": "boolean",
"title": "Inactive Billing"
},
"misc_data": {
"is_password": false,
"description": "Miscellaneous data used at run-time",
"title": "Misc Data",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"custom_string_1": {
"type": "string",
"title": "Custom String 1"
},
"custom_string_2": {
"type": "string",
"title": "Custom String 2"
},
"custom_string_3": {
"type": "string",
"title": "Custom String 3"
},
"custom_string_4": {
"type": "string",
"title": "Custom String 4"
},
"custom_string_5": {
"type": "string",
"title": "Custom String 5"
},
"custom_string_6": {
"type": "string",
"title": "Custom String 6"
},
"custom_string_7": {
"type": "string",
"title": "Custom String 7"
},
"custom_string_8": {
"type": "string",
"title": "Custom String 8"
},
"custom_string_9": {
"type": "string",
"title": "Custom String 9"
},
"custom_string_10": {
"type": "string",
"title": "Custom String 10"
},
"custom_boolean_1": {
"type": "boolean",
"title": "Custom Boolean 1"
},
"custom_boolean_2": {
"type": "boolean",
"title": "Custom Boolean 2"
},
"custom_boolean_3": {
"type": "boolean",
"title": "Custom Boolean 3"
},
"custom_boolean_4": {
"type": "boolean",
"title": "Custom Boolean 4"
},
"custom_boolean_5": {
"type": "boolean",
"title": "Custom Boolean 5"
},
"custom_boolean_6": {
"type": "boolean",
"title": "Custom Boolean 6"
},
"custom_boolean_7": {
"type": "boolean",
"title": "Custom Boolean 7"
},
"custom_boolean_8": {
"type": "boolean",
"title": "Custom Boolean 8"
},
"custom_boolean_9": {
"type": "boolean",
"title": "Custom Boolean 9"
},
"custom_boolean_10": {
"type": "boolean",
"title": "Custom Boolean 10"
},
"hcsCustomer": {
"title": "Hcs Customer",
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"shortName": {
"title": "Short Name",
"type": "string",
"maxLength": 64,
"required": true,
"readonly": false,
"is_password": false,
"displayable": false
},
"extendedName": {
"title": "Extended Name",
"type": "string",
"maxLength": 128,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"externalCustomerID": {
"title": "External Customer ID",
"type": "string",
"maxLength": 128,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"dealIDInfo": {
"title": "Deal ID Info",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"description": {
"title": "Description",
"type": "string",
"maxLength": 128,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"accountID": {
"title": "Account ID",
"type": "string",
"maxLength": 64,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"contactName": {
"title": "Contact Name",
"type": "string",
"maxLength": 128,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"contactAddress1": {
"title": "Contact Address1",
"type": "string",
"maxLength": 128,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"contactAddress2": {
"title": "Contact Address2",
"type": "string",
"maxLength": 128,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"contactCity": {
"title": "Contact City",
"type": "string",
"maxLength": 64,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"contactState": {
"title": "Contact State",
"type": "string",
"maxLength": 64,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"contactPostZip": {
"title": "Contact Post Zip",
"type": "string",
"maxLength": 32,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"contactCountry": {
"title": "Contact Country",
"type": "string",
"maxLength": 32,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"contactPhoneNumber": {
"title": "Contact Phone Number",
"type": "string",
"maxLength": 64,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"contactEmail": {
"title": "Contact Email",
"type": "string",
"maxLength": 128,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"cUOM": {
"title": "CUOM",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfCUOMDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfCUOMDAT",
"choices": []
},
"eLM": {
"title": "ELM",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfELMDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfELMDAT",
"choices": []
},
"cUCDM": {
"title": "CUCDM",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfCUCDMDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfCUCDMDAT",
"choices": []
},
"serviceProvider": {
"title": "Service Provider",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": true,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfServiceProviderDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfServiceProviderDAT",
"choices": []
},
"cCDM": {
"title": "CCDM",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfCCDMDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfCCDMDAT",
"choices": []
},
"cUCDM2": {
"title": "CUCDM2",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfCUCDM2DAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfCUCDM2DAT",
"choices": []
},
"directoryDomain": {
"title": "Directory Domain",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfDirectoryDomainDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfDirectoryDomainDAT",
"choices": []
},
"ownsCTX": {
"title": "Owns CTX",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfCTXDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfCTXDAT",
"choices": []
},
"monitorsPrimeCollab": {
"title": "Monitors Prime Collab",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfPrimeCollabDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfPrimeCollabDAT",
"choices": []
},
"reseller": {
"title": "Reseller",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfResellerDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfResellerDAT",
"choices": []
},
"usesCTX": {
"title": "Uses CTX",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfCTXDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfCTXDAT",
"choices": []
},
"northboundAdjacencies": {
"title": "Northbound Adjacencies",
"type": "array",
"minItems": 0,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"items": {
"type": "string",
"format": "uri",
"is_password": false,
"target": "/api/data/HCSHcmfNorthboundAdjacencyDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfNorthboundAdjacencyDAT",
"choices": []
}
},
"clusters": {
"title": "Clusters",
"type": "array",
"minItems": 0,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"items": {
"type": "string",
"format": "uri",
"is_password": false,
"target": "/api/data/HCSHcmfClusterDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfClusterDAT",
"choices": []
}
},
"usesTMSs": {
"title": "Uses TM Ss",
"type": "array",
"minItems": 0,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"items": {
"type": "string",
"format": "uri",
"is_password": false,
"target": "/api/data/HCSHcmfTMSDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfTMSDAT",
"choices": []
}
},
"usesTS_Virtuals": {
"title": "Uses TS Virtuals",
"type": "array",
"minItems": 0,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"items": {
"type": "string",
"format": "uri",
"is_password": false,
"target": "/api/data/HCSHcmfTS_VirtualDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfTS_VirtualDAT",
"choices": []
}
},
"usesTS_Hardwares": {
"title": "Uses TS Hardwares",
"type": "array",
"minItems": 0,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"items": {
"type": "string",
"format": "uri",
"is_password": false,
"target": "/api/data/HCSHcmfTS_HardwareDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfTS_HardwareDAT",
"choices": []
}
},
"usesMCUs": {
"title": "Uses MC Us",
"type": "array",
"minItems": 0,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"items": {
"type": "string",
"format": "uri",
"is_password": false,
"target": "/api/data/HCSHcmfMCUDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfMCUDAT",
"choices": []
}
},
"usesCTMSs": {
"title": "Uses CTM Ss",
"type": "array",
"minItems": 0,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"items": {
"type": "string",
"format": "uri",
"is_password": false,
"target": "/api/data/HCSHcmfCTMSDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfCTMSDAT",
"choices": []
}
},
"usesIVRs": {
"title": "Uses IV Rs",
"type": "array",
"minItems": 0,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"items": {
"type": "string",
"format": "uri",
"is_password": false,
"target": "/api/data/HCSHcmfIVRDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfIVRDAT",
"choices": []
}
},
"usesTS_Supervisors": {
"title": "Uses TS Supervisors",
"type": "array",
"minItems": 0,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"items": {
"type": "string",
"format": "uri",
"is_password": false,
"target": "/api/data/HCSHcmfTS_SupervisorDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfTS_SupervisorDAT",
"choices": []
}
},
"usesVPGWs": {
"title": "Uses VPG Ws",
"type": "array",
"minItems": 0,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"items": {
"type": "string",
"format": "uri",
"is_password": false,
"target": "/api/data/HCSHcmfVPGWDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfVPGWDAT",
"choices": []
}
}
}
},
"hcs_role": {
"title": "Hcs Role",
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"minItems": 0,
"is_password": false,
"required": false,
"readonly": false,
"displayable": false
},
"clonedRole": {
"title": "Role",
"description": "The role selector.",
"type": "string",
"minItems": 0,
"is_password": false,
"required": true,
"readonly": false,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
]
},
"role": {
"title": "Role",
"description": "The role selector.",
"type": "string",
"minItems": 0,
"is_password": false,
"required": true,
"readonly": false,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
]
}
}
},
"data_user": {
"title": "Data User",
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"minItems": 0,
"is_password": false,
"required": false,
"readonly": false,
"displayable": false
},
"password": {
"title": "Password",
"type": "string",
"minItems": 0,
"is_password": true,
"required": false,
"readonly": false,
"displayable": false
}
}
},
"dataUser": {
"title": "Data User",
"type": "object",
"properties": {
"username": {
"required": true,
"type": "string",
"description": "User's Username.",
"title": "User Name"
},
"email": {
"required": false,
"type": "string",
"description": "The User email address.",
"title": "Email Address"
},
"first_name": {
"type": "string",
"description": "The User first name.",
"title": "First Name"
},
"last_name": {
"type": "string",
"description": "The User last name.",
"title": "Last Name"
},
"password": {
"is_password": true,
"description": "The User password.",
"title": "Password",
"pattern": ".{8,}",
"type": "string",
"store_encrypted": true
},
"role": {
"description": "The role to which the user belongs. See: Role.",
"format": "uri",
"required": true,
"target_attr": "name",
"target": "/api/data/Role/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Role",
"type": "string",
"target_model_type": "data/Role",
"choices": []
},
"language": {
"description": "The preferred language for this user.",
"format": "uri",
"default": "en-us",
"required": false,
"target_attr": "lcid",
"target": "/api/data/Language/choices/?field=lcid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Language",
"type": "string",
"target_model_type": "data/Language",
"choices": []
},
"set_language": {
"description": "Indicate if the user's language is set by language default in the hierarchy.",
"title": "Set by Default Language",
"default": false,
"required": false,
"type": "boolean"
},
"account_information": {
"description": "Additional account information for the given user.",
"title": "Account Information",
"required": false,
"type": "object",
"properties": {
"change_password_on_login": {
"required": false,
"type": "boolean",
"description": "Indicates if the user must be forced to change their password the next time that login.",
"title": "Change Password on Next Login"
},
"locked": {
"required": false,
"type": "boolean",
"description": "Indicates if the account has been locked to prevent the user from logging in.",
"title": "Locked"
},
"disabled": {
"required": false,
"type": "boolean",
"description": "Indicates if the account has been disabled to prevent the user from logging in until an administrator enables the account again.",
"title": "Disabled"
},
"reason_for_disabled": {
"required": false,
"type": "string",
"description": "A description of why the account is disabled.",
"title": "Reason for Disabled"
},
"credential_policy": {
"description": "Specifies the policy with the rules used to govern this user's credentials.",
"format": "uri",
"required": false,
"target_attr": "name",
"target": "/api/data/CredentialPolicy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Credential Policy",
"type": "string",
"target_model_type": "data/CredentialPolicy",
"choices": []
},
"failed_login_lock_date": {
"description": "The time when the user account was locked as result of the number of failed login attempts exceeding the permitted thresholds.",
"format": "date-time",
"required": false,
"title": "Time Locked Due to Failed Login Attempts",
"type": "string"
},
"password_last_change_time": {
"description": "The time when the password was last changed.",
"format": "date-time",
"required": false,
"readonly": true,
"title": "Time of Last Password Change",
"type": "string"
},
"password_last_change_time_by_user": {
"description": "The time when the password was last changed by the user.",
"format": "date-time",
"required": false,
"readonly": true,
"title": "Time of Last Password Change By User",
"type": "string"
},
"last_login_time": {
"description": "The time the user last logged in successfully.",
"format": "date-time",
"required": false,
"readonly": true,
"title": "Time of Last Successful Login",
"type": "string"
},
"num_of_failed_login_attempts": {
"description": "The total number of failed login attempts since last successful login.",
"title": "Number of Failed Login Attempts Since Last Successful Login",
"default": "0",
"required": false,
"type": "integer"
},
"security_questions": {
"items": {
"type": "object",
"properties": {
"question": {
"title": "Question",
"required": true,
"displayable": true,
"maxLength": 128,
"type": "string"
},
"answer": {
"maxLength": 128,
"required": true,
"type": "string",
"title": "Answer"
}
}
},
"type": "array",
"title": "Security Questions"
},
"used_passwords": {
"items": {
"type": "object",
"properties": {
"password": {
"type": "string",
"description": "Used password",
"title": "Password"
},
"time_created": {
"type": "string",
"description": "Time when password was created.",
"title": "Time Created"
}
}
},
"type": "array",
"description": "List of passwords that have been used by user.",
"title": "Used Passwords"
}
}
},
"entitlement_profile": {
"is_password": false,
"format": "uri",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"title": "Entitlement Profile",
"type": "string",
"target": "/api/data/HcsEntitlementProfileDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HcsEntitlementProfileDAT",
"choices": []
},
"sync_source": {
"target": "/api/data/UserSyncSource/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"default": "LOCAL",
"title": "Sync Source",
"target_attr": "name",
"type": "string",
"description": "Sync source of the user. Identifies where the user was synced from. This value will determine the master of the data. The data in the User model will be derived from the fields of the master application (E.G. CUCM, CUC, MS-LDAP).",
"target_model_type": "data/UserSyncSource",
"choices": []
},
"sync_type": {
"default": "LOCAL",
"type": "string",
"description": "Sync type of the user. Identifies the user type that was synced from device as indicated by Sync Source information, e.g. CUCM-Local, CUCM-LDAP, LOCAL.",
"title": "Sync Type"
},
"building_name": {
"type": "string",
"description": "Building name or number.",
"title": "Building Name"
},
"country": {
"type": "string",
"description": "Country name.",
"title": "Country"
},
"department": {
"type": "string",
"description": "Department names and numbers.",
"title": "Department"
},
"directory_uri": {
"type": "string",
"description": "Alphanumeric Directory URI (e.g. SIP URI)",
"title": "Directory URI"
},
"display_name": {
"type": "string",
"description": "Display name of the user",
"title": "Display Name"
},
"employee_number": {
"type": "string",
"description": "Employee number of the user",
"title": "Employee Number"
},
"employee_type": {
"type": "string",
"description": "Employee type",
"title": "Employee Type"
},
"facsimile_telephone_number": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's facsimile telephone Number(s).",
"title": "Facsimile Telephone Number"
},
"home_phone": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's home phone number(s).",
"title": "Home Phone"
},
"ip_phone": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's IP phone number(s).",
"title": "IP Phone"
},
"jabber_id": {
"type": "string",
"description": "Jabber ID",
"title": "Jabber ID"
},
"city": {
"type": "string",
"description": "Contains the name of a person's locality.",
"title": "City"
},
"manager": {
"type": "string",
"description": "Manager.",
"title": "Manager"
},
"member_of": {
"items": {
"type": "string"
},
"type": "array",
"description": "The user can be a member of a variety of groups.",
"title": "Member Of"
},
"mobile": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's IP mobile number(s).",
"title": "Mobile"
},
"organization": {
"type": "string",
"description": "The name of the person's organization.",
"title": "Organization"
},
"object_class": {
"minItems": 0,
"items": {
"is_password": false,
"type": "string"
},
"type": "array",
"title": "Object Class"
},
"other_mailbox": {
"minItems": 0,
"items": {
"is_password": false,
"type": "string"
},
"type": "array",
"title": "Other Mailbox"
},
"ou": {
"description": "The name of the person's organization unit.",
"title": "Organizational Unit",
"minItems": 0,
"items": {
"is_password": false,
"type": "string"
},
"type": "array"
},
"photo_url": {
"type": "string",
"description": "Photo URL.",
"title": "Photo URL"
},
"physical_delivery_office_name": {
"type": "string",
"description": "Physical Delivery Office Name.",
"title": "Physical Delivery Office Name"
},
"postal_code": {
"type": "string",
"description": "Contains code used by a Postal Service to identify postal service zones.",
"title": "Postal Code"
},
"preferred_language": {
"type": "string",
"description": "Preferred Language.",
"title": "Preferred Language"
},
"state": {
"type": "string",
"description": "Contains full names of state or province.",
"title": "State"
},
"street": {
"type": "string",
"description": "Contains site information from a postal address.",
"title": "Street"
},
"telephone_number": {
"items": {
"type": "string"
},
"type": "array",
"description": "Telephone Number.",
"title": "Telephone Number"
},
"timezone": {
"type": "string",
"description": "Timezone.",
"title": "Timezone"
},
"title": {
"type": "string",
"description": "Title.",
"title": "Title"
},
"unverified_mailbox": {
"type": "string",
"description": "Unverified Mail Box.",
"title": "Unverified Mail Box"
},
"customString1": {
"type": "string",
"description": "Custom String",
"title": "Custom String 1"
},
"customString2": {
"type": "string",
"description": "Custom String",
"title": "Custom String 2"
},
"customString3": {
"type": "string",
"description": "Custom String",
"title": "Custom String 3"
},
"customString4": {
"type": "string",
"description": "Custom String",
"title": "Custom String 4"
},
"customString5": {
"type": "string",
"description": "Custom String",
"title": "Custom String 5"
},
"customString6": {
"type": "string",
"description": "Custom String",
"title": "Custom String 6"
},
"customString7": {
"type": "string",
"description": "Custom String",
"title": "Custom String 7"
},
"customString8": {
"type": "string",
"description": "Custom String",
"title": "Custom String 8"
},
"customString9": {
"type": "string",
"description": "Custom String",
"title": "Custom String 9"
},
"customString10": {
"type": "string",
"description": "Custom String",
"title": "Custom String 10"
},
"customListOfStrings1": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 1"
},
"customListOfStrings2": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 2"
},
"customListOfStrings3": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 3"
},
"customListOfStrings4": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 4"
},
"customListOfStrings5": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 5"
},
"customListOfStrings6": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 6"
},
"customListOfStrings7": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 7"
},
"customListOfStrings8": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 8"
},
"customListOfStrings9": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 9"
},
"customListOfStrings10": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 10"
},
"customBoolean1": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 1"
},
"customBoolean2": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 2"
},
"customBoolean3": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 3"
},
"customBoolean4": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 4"
},
"customBoolean5": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 5"
},
"customBoolean6": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 6"
},
"customBoolean7": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 7"
},
"customBoolean8": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 8"
},
"customBoolean9": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 9"
},
"customBoolean10": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 10"
},
"auth_method": {
"description": "The type of authentication that our user would be using. Typically this would be choices between a Standard VOSS 4 UC user, an LDAP user or an SSO user.",
"title": "Auth Method",
"default": "Local",
"choices": [
{
"value": "Local",
"title": "Local"
},
{
"value": "Automatic",
"title": "Automatic"
},
{
"value": "LDAP",
"title": "LDAP"
},
{
"value": "SSO",
"title": "SSO"
}
],
"type": "string"
},
"ldap_server": {
"description": "A reference to the LDAP server which this user must authenticate against.",
"format": "uri",
"required": false,
"target": "/api/data/Ldap/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "LDAP Server",
"type": "string",
"target_model_type": "data/Ldap",
"choices": []
},
"ldap_username": {
"type": "string",
"description": "The login attribute of the associated LDAP device model instance",
"title": "LDAP Username"
},
"sso_idp": {
"description": "The entity id of the SSO Identity Provider.",
"format": "uri",
"required": false,
"target_attr": "entity_id",
"target": "/api/data/SsoIdentityProvider/choices/?field=entity_id&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "SSO Identity Provider",
"type": "string",
"target_model_type": "data/SsoIdentityProvider",
"choices": []
},
"sso_username": {
"required": false,
"type": "string",
"description": "The name identifier that is used for an SSO authenticated user.",
"title": "SSO Username"
},
"user_type": {
"description": "Indicate the user's login type.",
"title": "User Type",
"default": "Admin",
"required": false,
"choices": [
{
"value": "Admin",
"title": "Admin"
},
{
"value": "End User",
"title": "End User"
},
{
"value": "End User + Admin",
"title": "End User + Admin"
}
],
"type": "string"
},
"exclude_from_directory": {
"type": "boolean",
"description": "Exclude from Directory flag to control the Phone Services directory lookup. If set to true the User's phone number will not appear in the directory lookup.",
"title": "Exclude from Directory"
},
"mvs_hybrid_status": {
"required": false,
"type": "string",
"title": "Hybrid Status"
},
"mvs_primary_line": {
"type": "string",
"title": "Primary Line"
},
"mvs_primary_line_cos": {
"type": "string",
"title": "Primary Class of Service"
},
"mvs_extensions": {
"description": "Extensions to select primary details from.",
"title": "Extensions",
"items": {
"type": "object",
"properties": {
"line": {
"type": "string",
"title": "Line"
},
"line_e164": {
"type": "string",
"title": "Line E164"
},
"line_cos": {
"type": "string",
"title": "Class of Service"
}
}
},
"required": false,
"type": "array"
},
"username_avaya_system_manager": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Avaya System Manager.",
"title": "Avaya System Manager User Name"
},
"username_broadworks": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Broadworks.",
"title": "Broadworks User Name"
},
"username_cuc": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Cisco Unity Connection.",
"title": "Cisco Unity Connection User Name"
},
"username_cucm": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Cisco Unified Communication Manager.",
"title": "Cisco Unified Communication Manager User Name"
},
"username_hcmf": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Cisco HCMF.",
"title": "HCMF User Name"
},
"username_ldap": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in the LDAP Directory.",
"title": "LDAP Directory User Name"
},
"username_microsoft": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Microsoft Username.",
"title": "Microsoft User Name"
},
"username_ms_365": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Microsoft Office 365.",
"title": "Microsoft Office 365 User Name"
},
"username_ms_ldap": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Microsoft LDAP.",
"title": "Microsoft LDAP User Name"
},
"username_ms_teams": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Microsoft Teams.",
"title": "Microsoft Teams User Name"
},
"username_open_ldap": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Opoen LDAP.",
"title": "Open LDAP User Name"
},
"username_uccx": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Cisco Unified Contact Centre Express.",
"title": "Cisco Unified Contact Centre Express User Name"
},
"username_webex_teams": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Webex App.",
"title": "Webex App User Name"
},
"username_zoom": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Zoom.",
"title": "Zoom User Name"
},
"authorized_admin_hierarchy": {
"description": "A reference an Authorized Admin Hierarchy instance that defines this user's administrative capabilities. This enables administrative capabilities for end users.",
"format": "uri",
"required": false,
"target_attr": "name",
"target": "/api/data/AuthorizedAdminHierarchy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Authorized Admin Hierarchy",
"type": "string",
"target_model_type": "data/AuthorizedAdminHierarchy",
"choices": []
},
"license_audit_details": {
"description": "License Audit Information.",
"title": "License Audit Details",
"required": false,
"type": "object",
"properties": {
"last_checked": {
"description": "The last time the License Audit Details were updated.",
"format": "date-time",
"required": false,
"readonly": true,
"title": "Last Checked",
"type": "string"
},
"status": {
"description": "The License Audit status of the user.",
"title": "License Audit Status",
"default": "Unknown",
"required": false,
"choices": [
{
"value": "Licensed",
"title": "Licensed"
},
{
"value": "Unlicensed",
"title": "Unlicensed"
},
{
"value": "Unknown",
"title": "Unknown"
}
],
"readonly": true,
"type": "string"
}
}
}
}
},
"baseCustomerDOM": {
"title": "Base Customer Dom",
"type": "object",
"properties": {
"name": {
"title": "Customer Name",
"type": "string",
"minLength": 1,
"maxLength": 64,
"required": true,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
},
"pattern": "^[\\w\\ -]+$"
},
"InternalCustomerID": {
"title": "Internal ID",
"type": "string",
"required": false,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
},
"default": "\"Auto Generated\""
},
"Description": {
"title": "Description",
"type": "string",
"required": false,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
}
},
"Address1": {
"title": "Address Line 1",
"type": "string",
"required": false,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
}
},
"Address2": {
"title": "Address Line 2",
"type": "string",
"required": false,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
}
},
"Address3": {
"title": "Address Line 3",
"type": "string",
"required": false,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
}
},
"CustomerID": {
"title": "Customer ID",
"type": "string",
"required": false,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
}
}
}
},
"baseCustomerDAT": {
"title": "Base Customer Dat",
"type": "object",
"properties": {
"CustomerName": {
"title": "Customer Name",
"type": "string",
"minLength": 1,
"maxLength": 64,
"required": true,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
},
"pattern": "^[\\w\\ -]+$"
},
"InternalCustomerID": {
"title": "Internal ID",
"type": "string",
"required": false,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
},
"default": "\"Auto Generated\""
},
"CustomerID": {
"title": "Customer ID",
"type": "string",
"required": false,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
}
},
"Address1": {
"title": "Address Line 1",
"type": "string",
"required": false,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
}
},
"Address2": {
"title": "Address Line 2",
"type": "string",
"required": false,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
}
},
"Address3": {
"title": "Address Line 3",
"type": "string",
"required": false,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
}
},
"Description": {
"title": "Description",
"type": "string",
"required": false,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
}
},
"Hierarchy": {
"title": "Hierarchy",
"type": "string",
"required": false,
"readonly": false,
"is_password": false,
"items": {
"is_password": false
}
}
}
}
}
},
"maxItems": 1
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/CustomerBuild-AddCiscoCustomer-WFC_REL/add/ |
|
The GUI Add form of relation/CustomerBuild-AddCiscoCustomer-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-AddCiscoCustomer-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-AddCiscoCustomer-WFC_REL | POST | /api/relation/CustomerBuild-AddCiscoCustomer-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-AddCiscoCustomer-WFC_REL/ |
|
The relation/CustomerBuild-AddCiscoCustomer-WFC_REL schema and all instances as JSON. |
(The list will return 0 to 3 relation/CustomerBuild-AddCiscoCustomer-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-AddCiscoCustomer-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-AddCiscoCustomer-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-AddCiscoCustomer-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-AddCiscoCustomer-WFC_REL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/CustomerBuild-AddCiscoCustomer-WFC_REL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/CustomerBuild-AddCiscoCustomer-WFC_REL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/CustomerBuild-AddCiscoCustomer-WFC_REL/[pkid] | hierarchy=[hierarchy] | The relation/CustomerBuild-AddCiscoCustomer-WFC_REL instance with [pkid]. |