[Index]
CustomerBuild-AddMicrosoftCustomer-WFC_REL
Model ref.: relation/CustomerBuild-AddMicrosoftCustomer-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_HcsCustomerREL": {
"items": {
"type": "object",
"properties": {
"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"
},
"custom_boolean_10": {
"type": "boolean",
"title": "Custom Boolean 10"
},
"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_4": {
"type": "string",
"title": "Custom String 4"
},
"custom_string_6": {
"type": "string",
"title": "Custom String 6"
},
"dataUser": {
"type": "object",
"properties": {
"last_name": {
"type": "string",
"description": "The User last name.",
"title": "Last 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"
},
"ldap_server": {
"description": "A reference to the LDAP server which this user must authenticate against.",
"title": "LDAP Server",
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "data/Ldap",
"type": "string",
"target": "/api/data/Ldap/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"manager": {
"type": "string",
"description": "Manager.",
"title": "Manager"
},
"postal_code": {
"type": "string",
"description": "Contains code used by a Postal Service to identify postal service zones.",
"title": "Postal Code"
},
"jabber_id": {
"type": "string",
"description": "Jabber ID",
"title": "Jabber ID"
},
"display_name": {
"type": "string",
"description": "Display name of the user",
"title": "Display Name"
},
"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"
},
"title": {
"type": "string",
"description": "Title.",
"title": "Title"
},
"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"
},
"home_phone": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's home phone number(s).",
"title": "Home Phone"
},
"customString3": {
"type": "string",
"description": "Custom String",
"title": "Custom String 3"
},
"customString2": {
"type": "string",
"description": "Custom String",
"title": "Custom String 2"
},
"customString1": {
"type": "string",
"description": "Custom String",
"title": "Custom String 1"
},
"customString7": {
"type": "string",
"description": "Custom String",
"title": "Custom String 7"
},
"customString6": {
"type": "string",
"description": "Custom String",
"title": "Custom String 6"
},
"customString5": {
"type": "string",
"description": "Custom String",
"title": "Custom String 5"
},
"customString4": {
"type": "string",
"description": "Custom String",
"title": "Custom String 4"
},
"customString9": {
"type": "string",
"description": "Custom String",
"title": "Custom String 9"
},
"customString8": {
"type": "string",
"description": "Custom String",
"title": "Custom String 8"
},
"mvs_primary_line_cos": {
"type": "string",
"title": "Primary Class of Service"
},
"mvs_hybrid_status": {
"required": false,
"type": "string",
"title": "Hybrid Status"
},
"username_ldap": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in the LDAP Directory.",
"title": "LDAP Directory User Name"
},
"password": {
"is_password": true,
"description": "The User password.",
"title": "Password",
"pattern": ".{8,}",
"store_encrypted": true,
"type": "string"
},
"mvs_primary_line": {
"type": "string",
"title": "Primary Line"
},
"account_information": {
"properties": {
"reason_for_disabled": {
"required": false,
"type": "string",
"description": "A description of why the account is disabled.",
"title": "Reason for Disabled"
},
"locked": {
"required": false,
"type": "boolean",
"description": "Indicates if the account has been locked to prevent the user from logging in.",
"title": "Locked"
},
"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"
},
"security_questions": {
"items": {
"type": "object",
"properties": {
"answer": {
"title": "Answer",
"required": true,
"type": "string",
"maxLength": 128
},
"question": {
"maxLength": 128,
"required": true,
"type": "string",
"displayable": true,
"title": "Question"
}
}
},
"type": "array",
"title": "Security Questions"
},
"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"
},
"credential_policy": {
"description": "Specifies the policy with the rules used to govern this user's credentials.",
"title": "Credential Policy",
"format": "uri",
"required": false,
"choices": [],
"target_attr": "name",
"target_model_type": "data/CredentialPolicy",
"type": "string",
"target": "/api/data/CredentialPolicy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"failed_login_lock_date": {
"title": "Time Locked Due to Failed Login Attempts",
"required": false,
"type": "string",
"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"
},
"password_last_change_time_by_user": {
"description": "The time when the password was last changed by the user.",
"title": "Time of Last Password Change By User",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"password_last_change_time": {
"description": "The time when the password was last changed.",
"title": "Time of Last Password Change",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"num_of_failed_login_attempts": {
"default": "0",
"required": false,
"type": "integer",
"description": "The total number of failed login attempts since last successful login.",
"title": "Number of Failed Login Attempts Since Last Successful Login"
},
"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"
},
"last_login_time": {
"description": "The time the user last logged in successfully.",
"title": "Time of Last Successful Login",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
}
},
"required": false,
"type": "object",
"description": "Additional account information for the given user.",
"title": "Account Information"
},
"telephone_number": {
"items": {
"type": "string"
},
"type": "array",
"description": "Telephone Number.",
"title": "Telephone Number"
},
"street": {
"type": "string",
"description": "Contains site information from a postal address.",
"title": "Street"
},
"object_class": {
"minItems": 0,
"items": {
"is_password": false,
"type": "string"
},
"type": "array",
"title": "Object Class"
},
"building_name": {
"type": "string",
"description": "Building name or number.",
"title": "Building Name"
},
"first_name": {
"type": "string",
"description": "The User first name.",
"title": "First Name"
},
"employee_number": {
"type": "string",
"description": "Employee number of the user",
"title": "Employee Number"
},
"username_cuc": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Cisco Unity Connection.",
"title": "Cisco Unity Connection User Name"
},
"entitlement_profile": {
"is_password": false,
"target_model_type": "data/HcsEntitlementProfileDAT",
"target": "/api/data/HcsEntitlementProfileDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"displayable": false,
"choices": [],
"readonly": false,
"maxLength": 1024,
"title": "Entitlement Profile",
"type": "string"
},
"state": {
"type": "string",
"description": "Contains full names of state or province.",
"title": "State"
},
"email": {
"required": false,
"type": "string",
"description": "The User email address.",
"title": "Email Address"
},
"username_microsoft": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Microsoft Username.",
"title": "Microsoft 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"
},
"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"
},
"sync_source": {
"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).",
"title": "Sync Source",
"default": "LOCAL",
"format": "uri",
"choices": [],
"target_attr": "name",
"target_model_type": "data/UserSyncSource",
"type": "string",
"target": "/api/data/UserSyncSource/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"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"
},
"auth_method": {
"default": "Local",
"choices": [
{
"value": "Local",
"title": "Local"
},
{
"value": "Automatic",
"title": "Automatic"
},
{
"value": "LDAP",
"title": "LDAP"
},
{
"value": "SSO",
"title": "SSO"
}
],
"type": "string",
"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"
},
"sso_idp": {
"description": "The entity id of the SSO Identity Provider.",
"title": "SSO Identity Provider",
"format": "uri",
"required": false,
"choices": [],
"target_attr": "entity_id",
"target_model_type": "data/SsoIdentityProvider",
"type": "string",
"target": "/api/data/SsoIdentityProvider/choices/?field=entity_id&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"customListOfStrings7": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 7"
},
"preferred_language": {
"type": "string",
"description": "Preferred Language.",
"title": "Preferred Language"
},
"country": {
"type": "string",
"description": "Country name.",
"title": "Country"
},
"username_open_ldap": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Opoen LDAP.",
"title": "Open LDAP User Name"
},
"unverified_mailbox": {
"type": "string",
"description": "Unverified Mail Box.",
"title": "Unverified Mail Box"
},
"mvs_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",
"description": "Extensions to select primary details from.",
"title": "Extensions"
},
"ldap_username": {
"type": "string",
"description": "The login attribute of the associated LDAP device model instance",
"title": "LDAP Username"
},
"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"
},
"facsimile_telephone_number": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's facsimile telephone Number(s).",
"title": "Facsimile Telephone Number"
},
"employee_type": {
"type": "string",
"description": "Employee type",
"title": "Employee Type"
},
"city": {
"type": "string",
"description": "Contains the name of a person's locality.",
"title": "City"
},
"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"
},
"username": {
"required": true,
"type": "string",
"description": "User's Username.",
"title": "User Name"
},
"physical_delivery_office_name": {
"type": "string",
"description": "Physical Delivery Office Name.",
"title": "Physical Delivery Office Name"
},
"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"
},
"language": {
"description": "The preferred language for this user.",
"format": "uri",
"default": "en-us",
"required": false,
"choices": [],
"target_attr": "lcid",
"target_model_type": "data/Language",
"title": "Language",
"type": "string",
"target": "/api/data/Language/choices/?field=lcid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"member_of": {
"items": {
"type": "string"
},
"type": "array",
"description": "The user can be a member of a variety of groups.",
"title": "Member Of"
},
"username_ms_ldap": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Microsoft LDAP.",
"title": "Microsoft LDAP User Name"
},
"customString10": {
"type": "string",
"description": "Custom String",
"title": "Custom String 10"
},
"ip_phone": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's IP phone number(s).",
"title": "IP Phone"
},
"customListOfStrings10": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 10"
},
"username_broadworks": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Broadworks.",
"title": "Broadworks User Name"
},
"customBoolean10": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 10"
},
"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"
},
"timezone": {
"type": "string",
"description": "Timezone.",
"title": "Timezone"
},
"directory_uri": {
"type": "string",
"description": "Alphanumeric Directory URI (e.g. SIP URI)",
"title": "Directory URI"
},
"other_mailbox": {
"minItems": 0,
"items": {
"is_password": false,
"type": "string"
},
"type": "array",
"title": "Other Mailbox"
},
"role": {
"description": "The role to which the user belongs. See: Role.",
"title": "Role",
"format": "uri",
"required": true,
"choices": [],
"target_attr": "name",
"target_model_type": "data/Role",
"type": "string",
"target": "/api/data/Role/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"department": {
"type": "string",
"description": "Department names and numbers.",
"title": "Department"
},
"username_zoom": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Zoom.",
"title": "Zoom 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"
},
"sso_username": {
"required": false,
"type": "string",
"description": "The name identifier that is used for an SSO authenticated user.",
"title": "SSO Username"
},
"username_hcmf": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Cisco HCMF.",
"title": "HCMF User Name"
},
"ou": {
"minItems": 0,
"items": {
"is_password": false,
"type": "string"
},
"type": "array",
"description": "The name of the person's organization unit.",
"title": "Organizational Unit"
},
"photo_url": {
"type": "string",
"description": "Photo URL.",
"title": "Photo URL"
},
"customBoolean7": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 7"
},
"customBoolean6": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 6"
},
"customBoolean5": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 5"
},
"customBoolean4": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 4"
},
"customBoolean3": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 3"
},
"customBoolean2": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 2"
},
"customBoolean1": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 1"
},
"mobile": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's IP mobile number(s).",
"title": "Mobile"
},
"customBoolean9": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 9"
},
"customBoolean8": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 8"
},
"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.",
"title": "Authorized Admin Hierarchy",
"format": "uri",
"required": false,
"choices": [],
"target_attr": "name",
"target_model_type": "data/AuthorizedAdminHierarchy",
"type": "string",
"target": "/api/data/AuthorizedAdminHierarchy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"organization": {
"type": "string",
"description": "The name of the person's organization.",
"title": "Organization"
},
"username_webex_teams": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Webex App.",
"title": "Webex App User Name"
},
"set_language": {
"default": false,
"required": false,
"type": "boolean",
"description": "Indicate if the user's language is set by language default in the hierarchy.",
"title": "Set by Default Language"
}
},
"title": "Data User"
},
"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"
},
"custom_boolean_4": {
"type": "boolean",
"title": "Custom Boolean 4"
},
"baseCustomerDOM": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Customer Name",
"minLength": 1,
"required": true,
"readonly": false,
"maxLength": 64,
"pattern": "^[\\w\\ -]+$",
"items": {
"is_password": false
},
"type": "string"
},
"Address1": {
"is_password": false,
"title": "Address Line 1",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"InternalCustomerID": {
"is_password": false,
"title": "Internal ID",
"default": "\"Auto Generated\"",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"Address3": {
"is_password": false,
"title": "Address Line 3",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"CustomerID": {
"is_password": false,
"title": "Customer ID",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"Address2": {
"is_password": false,
"title": "Address Line 2",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"Description": {
"is_password": false,
"title": "Description",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
}
},
"title": "Base Customer Dom"
},
"hcs_role": {
"type": "object",
"properties": {
"role": {
"is_password": false,
"description": "The role selector.",
"title": "Role",
"minItems": 0,
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"type": "string"
},
"name": {
"is_password": false,
"title": "Name",
"minItems": 0,
"required": false,
"displayable": false,
"readonly": false,
"type": "string"
},
"clonedRole": {
"is_password": false,
"description": "The role selector.",
"title": "Role",
"minItems": 0,
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"type": "string"
}
},
"title": "Hcs Role"
},
"baseCustomerDAT": {
"type": "object",
"properties": {
"CustomerName": {
"is_password": false,
"title": "Customer Name",
"minLength": 1,
"required": true,
"readonly": false,
"maxLength": 64,
"pattern": "^[\\w\\ -]+$",
"items": {
"is_password": false
},
"type": "string"
},
"Hierarchy": {
"is_password": false,
"title": "Hierarchy",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"Address1": {
"is_password": false,
"title": "Address Line 1",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"InternalCustomerID": {
"is_password": false,
"title": "Internal ID",
"default": "\"Auto Generated\"",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"Address3": {
"is_password": false,
"title": "Address Line 3",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"CustomerID": {
"is_password": false,
"title": "Customer ID",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"Address2": {
"is_password": false,
"title": "Address Line 2",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
},
"Description": {
"is_password": false,
"title": "Description",
"items": {
"is_password": false
},
"required": false,
"readonly": false,
"type": "string"
}
},
"title": "Base Customer Dat"
},
"directoryDomain": {
"is_password": false,
"description": "Customer's directory domain name",
"title": "Directory Domain",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"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"
},
"hcsCustomer": {
"type": "object",
"properties": {
"cUCDM": {
"target": "/api/device/hcmf/CUCDM/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/CUCDM",
"title": "cUCDM",
"type": [
"string",
"null"
],
"name": "cUCDM"
},
"contactCountry": {
"type": [
"string",
"null"
],
"name": "contactCountry",
"title": "contactCountry"
},
"contactAddress2": {
"type": [
"string",
"null"
],
"name": "contactAddress2",
"title": "contactAddress2"
},
"contactCity": {
"type": [
"string",
"null"
],
"name": "contactCity",
"title": "contactCity"
},
"directoryDomain": {
"target": "/api/device/hcmf/DirectoryDomain/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/DirectoryDomain",
"title": "directoryDomain",
"type": [
"string",
"null"
],
"name": "directoryDomain"
},
"contactEmail": {
"type": [
"string",
"null"
],
"name": "contactEmail",
"title": "contactEmail"
},
"cdmUpdateTimestamp": {
"readonly": true,
"type": [
"string",
"null"
],
"name": "cdmUpdateTimestamp",
"title": "cdmUpdateTimestamp"
},
"contactName": {
"type": [
"string",
"null"
],
"name": "contactName",
"title": "contactName"
},
"id": {
"type": [
"string",
"null"
],
"name": "id",
"title": "id"
},
"usesVPGWs": {
"items": {
"target": "/api/device/hcmf/VPGW/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/VPGW",
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
],
"name": "usesVPGWs",
"title": "usesVPGWs"
},
"usesTMSs": {
"items": {
"target": "/api/device/hcmf/TMS/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/TMS",
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
],
"name": "usesTMSs",
"title": "usesTMSs"
},
"isModifiable": {
"readonly": true,
"type": [
"boolean",
"null"
],
"name": "isModifiable",
"title": "isModifiable"
},
"serviceProvider": {
"target": "/api/device/hcmf/ServiceProvider/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": true,
"choices": [],
"target_model_type": "device/hcmf/ServiceProvider",
"title": "serviceProvider",
"type": "string",
"name": "serviceProvider"
},
"usesCTX": {
"target": "/api/device/hcmf/CTX/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/CTX",
"title": "usesCTX",
"type": [
"string",
"null"
],
"name": "usesCTX"
},
"clusters": {
"items": {
"target": "/api/device/hcmf/Cluster/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/Cluster",
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
],
"name": "clusters",
"title": "clusters"
},
"type": {
"name": "type",
"title": "type",
"default": "Customer",
"required": true,
"readonly": true,
"type": "string"
},
"usesCTMSs": {
"items": {
"target": "/api/device/hcmf/CTMS/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/CTMS",
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
],
"name": "usesCTMSs",
"title": "usesCTMSs"
},
"cUCDM2": {
"target": "/api/device/hcmf/CUCDM2/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/CUCDM2",
"title": "cUCDM2",
"type": [
"string",
"null"
],
"name": "cUCDM2"
},
"accountID": {
"type": [
"string",
"null"
],
"name": "accountID",
"title": "accountID"
},
"contactPhoneNumber": {
"type": [
"string",
"null"
],
"name": "contactPhoneNumber",
"title": "contactPhoneNumber"
},
"contactAddress1": {
"type": [
"string",
"null"
],
"name": "contactAddress1",
"title": "contactAddress1"
},
"description": {
"type": [
"string",
"null"
],
"name": "description",
"title": "description"
},
"contactPostZip": {
"type": [
"string",
"null"
],
"name": "contactPostZip",
"title": "contactPostZip"
},
"northboundAdjacencies": {
"items": {
"target": "/api/device/hcmf/NorthboundAdjacency/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/NorthboundAdjacency",
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
],
"name": "northboundAdjacencies",
"title": "northboundAdjacencies"
},
"contactState": {
"type": [
"string",
"null"
],
"name": "contactState",
"title": "contactState"
},
"dealIDInfo": {
"type": [
"string",
"null"
],
"name": "dealIDInfo",
"title": "dealIDInfo"
},
"ownsCTX": {
"target": "/api/device/hcmf/CTX/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/CTX",
"title": "ownsCTX",
"type": [
"string",
"null"
],
"name": "ownsCTX"
},
"extendedName": {
"type": [
"string",
"null"
],
"name": "extendedName",
"searchable": "Customer",
"title": "extendedName"
},
"usesIVRs": {
"items": {
"target": "/api/device/hcmf/IVR/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/IVR",
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
],
"name": "usesIVRs",
"title": "usesIVRs"
},
"externalCustomerID": {
"type": [
"string",
"null"
],
"name": "externalCustomerID",
"title": "externalCustomerID"
},
"shortName": {
"required": true,
"type": "string",
"name": "shortName",
"searchable": "Customer",
"title": "shortName"
},
"isDeletable": {
"readonly": true,
"type": [
"boolean",
"null"
],
"name": "isDeletable",
"title": "isDeletable"
},
"usesMCUs": {
"items": {
"target": "/api/device/hcmf/MCU/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/MCU",
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
],
"name": "usesMCUs",
"title": "usesMCUs"
},
"usesTS_Hardwares": {
"items": {
"target": "/api/device/hcmf/TS_Hardware/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/TS_Hardware",
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
],
"name": "usesTS_Hardwares",
"title": "usesTS_Hardwares"
},
"monitorsPrimeCollab": {
"target": "/api/device/hcmf/PrimeCollab/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/PrimeCollab",
"title": "monitorsPrimeCollab",
"type": [
"string",
"null"
],
"name": "monitorsPrimeCollab"
},
"reseller": {
"target": "/api/device/hcmf/Reseller/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/Reseller",
"title": "reseller",
"type": [
"string",
"null"
],
"name": "reseller"
},
"cCDM": {
"target": "/api/device/hcmf/CCDM/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/CCDM",
"title": "cCDM",
"type": [
"string",
"null"
],
"name": "cCDM"
},
"usesTS_Virtuals": {
"items": {
"target": "/api/device/hcmf/TS_Virtual/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/TS_Virtual",
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
],
"name": "usesTS_Virtuals",
"title": "usesTS_Virtuals"
},
"eLM": {
"target": "/api/device/hcmf/ELM/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/ELM",
"title": "eLM",
"type": [
"string",
"null"
],
"name": "eLM"
},
"usesTS_Supervisors": {
"items": {
"target": "/api/device/hcmf/TS_Supervisor/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/TS_Supervisor",
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
],
"name": "usesTS_Supervisors",
"title": "usesTS_Supervisors"
},
"cUOM": {
"target": "/api/device/hcmf/CUOM/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/CUOM",
"title": "cUOM",
"type": [
"string",
"null"
],
"name": "cUOM"
},
"syncTimestamp": {
"readonly": true,
"type": [
"string",
"null"
],
"name": "syncTimestamp",
"title": "syncTimestamp"
}
},
"title": "Hcs Customer"
},
"custom_string_10": {
"type": "string",
"title": "Custom String 10"
},
"data_user": {
"type": "object",
"properties": {
"password": {
"is_password": true,
"title": "Password",
"minItems": 0,
"required": false,
"displayable": false,
"readonly": false,
"type": "string"
},
"name": {
"is_password": false,
"title": "Name",
"minItems": 0,
"required": false,
"displayable": false,
"readonly": false,
"type": "string"
}
},
"title": "Data User"
},
"custom_string_9": {
"type": "string",
"title": "Custom String 9"
},
"custom_string_8": {
"type": "string",
"title": "Custom String 8"
},
"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"
},
"custom_string_1": {
"type": "string",
"title": "Custom String 1"
},
"custom_string_3": {
"type": "string",
"title": "Custom String 3"
},
"custom_string_2": {
"type": "string",
"title": "Custom String 2"
},
"custom_string_5": {
"type": "string",
"title": "Custom String 5"
},
"publicSector": {
"default": "false",
"type": "boolean",
"title": "Public Sector"
},
"custom_string_7": {
"type": "string",
"title": "Custom String 7"
},
"inactiveBilling": {
"default": "false",
"type": "boolean",
"title": "Inactive Billing"
},
"custom_boolean_5": {
"type": "boolean",
"title": "Custom Boolean 5"
},
"HierarchyPath": {
"is_password": false,
"description": "Customer entity's hierarchy",
"title": "Hierarchy Path",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"custom_boolean_7": {
"type": "boolean",
"title": "Custom Boolean 7"
},
"custom_boolean_6": {
"type": "boolean",
"title": "Custom Boolean 6"
},
"custom_boolean_1": {
"type": "boolean",
"title": "Custom Boolean 1"
},
"custom_boolean_3": {
"type": "boolean",
"title": "Custom Boolean 3"
},
"custom_boolean_2": {
"type": "boolean",
"title": "Custom Boolean 2"
},
"disableNumMgmt": {
"is_password": false,
"description": "Disables number management",
"title": "Disable Number Management",
"default": "false",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"custom_boolean_9": {
"type": "boolean",
"title": "Custom Boolean 9"
},
"custom_boolean_8": {
"type": "boolean",
"title": "Custom Boolean 8"
}
}
},
"type": "array",
"maxItems": 1,
"title": "Relation Hcs Customer 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-AddMicrosoftCustomer-WFC_REL/add/ |
|
The GUI Add form of relation/CustomerBuild-AddMicrosoftCustomer-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-AddMicrosoftCustomer-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-AddMicrosoftCustomer-WFC_REL | POST | /api/relation/CustomerBuild-AddMicrosoftCustomer-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-AddMicrosoftCustomer-WFC_REL/ |
|
The relation/CustomerBuild-AddMicrosoftCustomer-WFC_REL schema and all instances as JSON. |
(The list will return 0 to 3 relation/CustomerBuild-AddMicrosoftCustomer-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-AddMicrosoftCustomer-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-AddMicrosoftCustomer-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-AddMicrosoftCustomer-WFC_REL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/CustomerBuild-AddMicrosoftCustomer-WFC_REL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/CustomerBuild-AddMicrosoftCustomer-WFC_REL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
}
],
"model_type": "relation/CustomerBuild-AddMicrosoftCustomer-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-AddMicrosoftCustomer-WFC_REL/[pkid] | hierarchy=[hierarchy] | The relation/CustomerBuild-AddMicrosoftCustomer-WFC_REL instance with [pkid]. |