[Index]
Multi Vendor Subscriber Edit Relation
Model ref.: relation/MultiVendorSubscriber
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": {
"last_name": {
"type": "string",
"description": "The User last name.",
"title": "Last Name"
},
"msteam": {
"type": "object",
"properties": {
"ms365": {
"type": "object",
"properties": {
"MobileNumber": {
"type": "string",
"title": "Mobile Number"
},
"PhoneNumber": {
"type": "string",
"title": "Phone Number"
},
"LocationUsage": {
"type": "string",
"title": "Location Usage"
}
},
"title": "365"
},
"azure_user_data": {
"type": "string",
"title": "Microsoft Azure Data"
},
"qa_msteam_delete": {
"type": "string",
"title": "Delete"
},
"ms_user": {
"type": "string",
"title": "Microsoft User"
},
"ms_user_link": {
"format": "link",
"type": "string",
"title": "Microsoft User"
},
"ms_user_data": {
"type": "string",
"title": "Microsoft User Data"
},
"qa_msteam_add": {
"type": "string",
"title": "Add"
},
"msteams": {
"type": "object",
"properties": {
"FeatureTypes": {
"items": {
"type": "string"
},
"type": "array",
"title": "Feature Types"
},
"AccountEnabled": {
"type": "boolean",
"title": "Account Enabled"
},
"TenantDialPlan": {
"type": "string",
"title": "Tenant Dial Plan"
},
"TeamsCallParkPolicy": {
"type": "string",
"title": "Teams Call Park Policy"
},
"UserPrincipalName": {
"type": "string",
"title": "User Principal Name"
},
"LineURItel": {
"type": "string",
"title": "Line URI"
},
"TeamsCallingPolicy": {
"type": "string",
"title": "Teams Calling Policy"
},
"OnlineVoiceRoutingPolicy": {
"type": "string",
"title": "Online Voice Routing Policy"
},
"TeamsEmergencyCallRoutingPolicy": {
"type": "string",
"title": "Teams Emergency Call Routing Policy"
},
"LineURIType": {
"type": "string",
"title": "Line URI Type"
}
},
"title": "Teams"
},
"qa_msteam_edit": {
"type": "string",
"title": "Edit"
},
"ms_user_pkid": {
"type": "string",
"title": "Microsoft User PKID"
},
"mslicenses": {
"type": "object",
"properties": {
"AccountSkuId": {
"type": "string",
"title": "License Summary"
},
"IsLicensed": {
"type": "string",
"title": "Is Licensed"
}
},
"title": "Licenses"
}
},
"title": "Msteam"
},
"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"
},
"mvs_user": {
"type": "object",
"properties": {
"associated_profiles": {
"type": "string",
"title": "Associated Profiles"
},
"discovered_services": {
"type": "string",
"title": "Discovered Services"
},
"associated_rdp": {
"type": "string",
"title": "Associated SNR"
},
"discovered_apps": {
"type": "string",
"title": "Discovered Applications"
},
"associated_vm": {
"type": "string",
"title": "Associated VM"
},
"associated_headset": {
"type": "string",
"title": "Associated Headset"
},
"associated_ms": {
"type": "string",
"title": "Associated Microsoft User Data"
},
"line_by_pattern": {
"type": "string",
"title": "VOSS User Line by pattern"
},
"associated_phones": {
"type": "string",
"title": "Associated Phones"
},
"enabled_services": {
"type": "string",
"title": "Enabled Services"
},
"ms_user_pkid": {
"type": "string",
"title": "Associated Microsoft User PKID"
},
"associated_lines": {
"type": "string",
"title": "VOSS User Associated Lines"
},
"username": {
"type": "string",
"title": "VOSS User"
},
"associated_webex": {
"type": "string",
"title": "Associated WebEx"
},
"associated_webexapp_user": {
"type": "string",
"title": "Associated Webex App User"
},
"ms_teams_user_pkid": {
"type": "string",
"title": "Associated Microsoft Teams User PKID"
},
"cucm_user_pkid": {
"type": "string",
"title": "Associated CUCM User PKID"
},
"line": {
"type": "string",
"title": "VOSS User Line"
},
"associated_pexip": {
"type": "string",
"title": "Associated Pexip"
},
"associated_fdp": {
"type": "string",
"title": "Associated FDP"
},
"associated_cucm_user": {
"type": "string",
"title": "Associated Cucm User"
},
"associated_ccx": {
"type": "string",
"title": "Associated CCX"
},
"located_at": {
"type": "string",
"title": "VOSS User Located at"
},
"associated_webexapp_user_config": {
"type": "string",
"title": "Associated Webex App User Config"
}
},
"title": "Mvs User"
},
"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"
},
"cisco_phone": {
"type": "object",
"properties": {
"qa_delete": {
"type": "string",
"title": "Delete"
},
"qa_reset": {
"type": "string",
"title": "Reset"
},
"name": {
"type": "string",
"title": "Phone Name"
},
"cucm_user_phone_link": {
"format": "link",
"type": "string",
"title": "Cisco CUCM User"
},
"cucm_user_link": {
"format": "link",
"type": "string",
"title": "Cisco CUCM User"
},
"qa_add": {
"type": "string",
"title": "Add"
},
"cucm_user_data": {
"type": "string",
"title": "Cisco CUCM User Data"
},
"lines": {
"type": "string",
"title": "Phone Lines"
},
"associated_phones": {
"type": "string",
"title": "Associated Phones"
},
"qa_generate_prt": {
"type": "string",
"title": "Generate PRT"
},
"cucm_user": {
"type": "string",
"title": "Cisco CUCM User"
},
"type": {
"type": "string",
"title": "Phone Type"
},
"qa_replace": {
"type": "string",
"title": "Replace"
},
"cucm_user_phone_data": {
"type": "string",
"title": "Cisco CUCM Phone Data"
}
},
"title": "Cisco Phone"
},
"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"
},
"headset": {
"type": "object",
"properties": {
"headset_model": {
"type": "string",
"title": "Model"
},
"lastChangeTime": {
"type": "string",
"title": "Last Status Update"
},
"qa_associate": {
"type": "string",
"title": "Associate"
},
"headset_serialNumber": {
"type": "string",
"title": "Serial Number"
},
"headset_connectionType": {
"type": "string",
"title": "Connection Type"
},
"cucm_user": {
"type": "string",
"title": "Cisco CUCM User"
},
"qa_disassociate": {
"type": "string",
"title": "Disassociate"
},
"headset_vendor": {
"type": "string",
"title": "Vendor"
},
"host_deviceNameTrimmed": {
"type": "string",
"title": "Connected Device"
},
"headset_firmwareVersion": {
"type": "string",
"title": "Firmware Version"
},
"headset_connectionStatus": {
"type": "string",
"title": "Connection Status"
}
},
"title": "Headset"
},
"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"
},
"mso365": {
"type": "object",
"properties": {
"ms365": {
"type": "object",
"properties": {
"MobileNumber": {
"type": "string",
"title": "Mobile Number"
},
"PhoneNumber": {
"type": "string",
"title": "Phone Number"
},
"LocationUsage": {
"type": "string",
"title": "Location Usage"
}
},
"title": "365"
},
"azure_user_data": {
"type": "string",
"title": "Microsoft Azure Data"
},
"ms_user": {
"type": "string",
"title": "Microsoft User"
},
"ms_user_link": {
"format": "link",
"type": "string",
"title": "Microsoft User"
},
"ms_user_data": {
"type": "string",
"title": "Microsoft User Data"
},
"qa_mso365_delete": {
"type": "string",
"title": "Delete"
},
"qa_mso365_edit": {
"type": "string",
"title": "Edit"
},
"msteams": {
"type": "object",
"properties": {
"AccountEnabled": {
"type": "boolean",
"title": "Account Enabled"
},
"TenantDialPlan": {
"type": "string",
"title": "Tenant Dial Plan"
},
"EnterpriseVoiceEnabled": {
"type": "boolean",
"title": "Enterprise Voice Enabled"
},
"UserPrincipalName": {
"type": "string",
"title": "User Principal Name"
},
"LineURItel": {
"type": "string",
"title": "Line URI"
},
"TeamsCallingPolicy": {
"type": "string",
"title": "Teams Calling Policy"
},
"OnlineVoiceRoutingPolicy": {
"type": "string",
"title": "Online Voice Routing Policy"
},
"TeamsEmergencyCallRoutingPolicy": {
"type": "string",
"title": "Teams Emergency Call Routing Policy"
},
"TeamsCallParkPolicy": {
"type": "string",
"title": "Teams Call Park Policy"
}
},
"title": "Teams"
},
"ms_user_pkid": {
"type": "string",
"title": "Microsoft User PKID"
},
"mslicenses": {
"type": "object",
"properties": {
"AccountSkuId": {
"type": "string",
"title": "Account SKU ID"
},
"IsLicensed": {
"type": "string",
"title": "Is Licensed"
}
},
"title": "Licenses"
},
"qa_mso365_add": {
"type": "string",
"title": "Add"
}
},
"title": "Mso365"
},
"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"
},
"hybrid_status": {
"type": "object",
"properties": {
"username": {
"type": "string",
"title": "VOSS User"
},
"qa_add_hybrid_subscriber": {
"type": "string",
"title": "Add Hybrid Subscriber"
},
"qa_update_hybrid_status": {
"type": "string",
"title": "Update Hybrid Status"
}
},
"title": "Hybrid Status"
},
"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"
},
"cisco_ccx": {
"type": "object",
"properties": {
"qa_delete": {
"type": "string",
"title": "Delete"
},
"extension": {
"type": "string",
"title": "Extension"
},
"cucm_user_link": {
"format": "link",
"type": "string",
"title": "Cisco CUCM User"
},
"skills": {
"type": "string",
"title": "Skills"
},
"qa_add": {
"type": "string",
"title": "Add"
},
"qa_edit": {
"type": "string",
"title": "Edit"
},
"cucm_user_data": {
"type": "string",
"title": "Cisco CUCM User Data"
},
"resourceGroupName": {
"type": "string",
"title": "Resource Group"
},
"teamName": {
"type": "string",
"title": "Team Name"
},
"cucm_user": {
"type": "string",
"title": "Cisco CUCM User"
},
"type": {
"type": "string",
"title": "User Type"
},
"autoAvailable": {
"type": "string",
"title": "Auto Available"
}
},
"title": "Cisco Ccx"
},
"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"
},
"cisco_webexapp_calling": {
"type": "object",
"properties": {
"qa_delete": {
"type": "string",
"title": "Delete"
},
"associated_webexteam": {
"type": "string",
"title": "Associated Webex Team Data"
},
"qa_edit": {
"type": "string",
"title": "Edit"
},
"call_waiting": {
"type": "string",
"title": "Call Waiting"
},
"voicemail_send": {
"type": "string",
"title": "Voicemail Send"
},
"cucm_user": {
"type": "string",
"title": "Cisco CUCM User"
},
"call_intercept": {
"type": "string",
"title": "Call Intercept"
},
"call_recording": {
"type": "string",
"title": "Call Recording"
},
"caller_id": {
"type": "string",
"title": "Caller ID"
},
"barge_in": {
"type": "string",
"title": "Barge"
},
"call_forward": {
"type": "string",
"title": "Call Forward"
},
"qa_add": {
"type": "string",
"title": "Add"
}
},
"title": "Cisco Webexapp Calling"
},
"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"
},
"mvs_user_qa": {
"type": "object",
"properties": {
"username": {
"type": "string",
"title": "VOSS User"
},
"qa_ms_qas": {
"type": "string",
"title": "Quick Subscriber (MS)"
},
"qa_cucm_qas": {
"type": "string",
"title": "Quick Subscriber (Cisco UCM)"
},
"qa_update_group_membership": {
"type": "string",
"title": "Update Group Membership"
},
"qa_move_subscriber": {
"type": "string",
"title": "Move Subscriber"
},
"qa_login_phone": {
"type": "string",
"title": "Login Phone"
},
"qa_update_cisco_user": {
"type": "string",
"title": "Update User (Cisco UCM)"
},
"qa_cpg_add": {
"type": "string",
"title": "Add to Call Pickup Group"
},
"qa_update_subscriber_from_profile": {
"type": "string",
"title": "Update Subscriber (Profile)"
},
"qa_reassign_services": {
"type": "string",
"title": "Reassign Services"
},
"qa_huntgroup_del": {
"type": "string",
"title": "Remove from all Hunt Groups"
},
"qa_update_services": {
"type": "string",
"title": "Update Services"
},
"qa_delete_services": {
"type": "string",
"title": "Delete All Services"
},
"qa_refresh": {
"type": "string",
"title": "Refresh"
},
"qa_huntgroup_add": {
"type": "string",
"title": "Add to Hunt Group"
},
"qa_reset_pin_passwd": {
"type": "string",
"title": "Reset Pin / Password"
},
"qa_logout_phone": {
"type": "string",
"title": "Logout Phone"
},
"qa_cpg_del": {
"type": "string",
"title": "Remove from all Call Pickup Groups"
}
},
"title": "Mvs User Qa"
},
"cisco_jabber": {
"type": "object",
"properties": {
"qa_delete": {
"type": "string",
"title": "Delete"
},
"qa_reset": {
"type": "string",
"title": "Reset"
},
"name": {
"type": "string",
"title": "Phone Name"
},
"cucm_user_phone_link": {
"format": "link",
"type": "string",
"title": "Cisco CUCM User"
},
"cucm_user_link": {
"format": "link",
"type": "string",
"title": "Cisco CUCM User"
},
"qa_add": {
"type": "string",
"title": "Add"
},
"cucm_user_data": {
"type": "string",
"title": "Cisco CUCM User Data"
},
"lines": {
"type": "string",
"title": "Phone Lines"
},
"associated_phones": {
"type": "string",
"title": "Associated Phones"
},
"qa_generate_prt": {
"type": "string",
"title": "Generate PRT"
},
"cucm_user": {
"type": "string",
"title": "Cisco CUCM User"
},
"type": {
"type": "string",
"title": "Phone Type"
},
"qa_replace": {
"type": "string",
"title": "Replace"
},
"cucm_user_phone_data": {
"type": "string",
"title": "Cisco CUCM Phone Data"
}
},
"title": "Cisco Jabber"
},
"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"
},
"cisco_vm": {
"type": "object",
"properties": {
"qa_delete": {
"type": "string",
"title": "Delete"
},
"qa_unlock_account": {
"type": "string",
"title": "Unlock Account"
},
"qa_edit": {
"type": "string",
"title": "Edit"
},
"cuc_user_data": {
"type": "string",
"title": "Cisco CUC User Data"
},
"qa_lock_account": {
"type": "string",
"title": "Lock Account"
},
"pin_user_locked": {
"type": "boolean",
"title": "User Locked"
},
"cuc_user": {
"type": "string",
"title": "Cisco CUC User"
},
"account_number": {
"type": "string",
"title": "VM Account Number"
},
"pin_locked": {
"type": "boolean",
"title": "Admin Locked"
},
"cuc_user_link": {
"format": "link",
"type": "string",
"title": "Cisco CUC User"
},
"qa_add": {
"type": "string",
"title": "Add"
},
"cuc_lines": {
"type": "boolean",
"title": "CUC Lines"
}
},
"title": "Cisco Vm"
},
"cisco_webexapp_user": {
"type": "object",
"properties": {
"qa_delete": {
"type": "string",
"title": "Delete"
},
"associated_webexteam": {
"type": "string",
"title": "Associated Webex Team Data"
},
"qa_edit": {
"type": "string",
"title": "Edit"
},
"cucm_user": {
"type": "string",
"title": "Cisco CUCM User"
},
"licenses": {
"type": "string",
"title": "Licenses"
},
"qa_add": {
"type": "string",
"title": "Add"
},
"invitePending": {
"type": "string",
"title": "Invite Pending"
},
"loginEnabled": {
"type": "string",
"title": "Login Enabled"
}
},
"title": "Cisco Webexapp User"
},
"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"
},
"cisco_snr": {
"type": "object",
"properties": {
"qa_delete": {
"type": "string",
"title": "Delete"
},
"cucm_user_rdp_data": {
"type": "string",
"title": "Cisco CUCM RDP Data"
},
"cucm_user_link": {
"format": "link",
"type": "string",
"title": "Cisco CUCM User"
},
"qa_edit": {
"type": "string",
"title": "Edit"
},
"cucm_user_data": {
"type": "string",
"title": "Cisco CUCM User Data"
},
"cucm_user": {
"type": "string",
"title": "Cisco CUCM User"
},
"associated_rdp": {
"type": "string",
"title": "Associated SNR"
},
"line": {
"type": "string",
"title": "Line"
},
"qa_add": {
"type": "string",
"title": "Add"
},
"cucm_user_rdp_link": {
"format": "link",
"type": "string",
"title": "Cisco CUCM User"
},
"RemoteDestination": {
"type": "string",
"title": "Mobile Number"
}
},
"title": "Cisco Snr"
},
"cisco_user": {
"type": "object",
"properties": {
"username": {
"required": true,
"type": "string",
"title": "VOSS User"
},
"selfService": {
"readonly": true,
"required": false,
"type": "string",
"title": "Meeting Number"
},
"imAndPresenceEnable": {
"required": false,
"type": "boolean",
"title": "IM And Presence Enable"
},
"enableUserToHostConferenceNow": {
"required": false,
"type": "boolean",
"title": "Enable User To Host Conference Now"
},
"attendeesAccessCode": {
"required": false,
"type": "string",
"title": "Attendees Access Code "
},
"ipccExtension": {
"required": false,
"type": "string",
"title": "IPCC Extension"
}
},
"title": "Cisco User"
},
"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"
},
"cisco_em": {
"type": "object",
"properties": {
"qa_delete": {
"type": "string",
"title": "Delete"
},
"name": {
"type": "string",
"title": "EM Name"
},
"cucm_user_link": {
"format": "link",
"type": "string",
"title": "Cisco CUCM User"
},
"qa_add": {
"type": "string",
"title": "Add"
},
"qa_edit": {
"type": "string",
"title": "Edit"
},
"cucm_user_data": {
"type": "string",
"title": "Cisco CUCM User Data"
},
"lines": {
"type": "string",
"title": "EM Lines"
},
"cucm_user": {
"type": "string",
"title": "Cisco CUCM User"
},
"associated_profiles": {
"type": "string",
"title": "Associated Profiles"
},
"cucm_user_em_link": {
"format": "link",
"type": "string",
"title": "Cisco CUCM EM"
},
"type": {
"type": "string",
"title": "EM Type"
},
"cucm_user_em_data": {
"type": "string",
"title": "Cisco CUCM EM Data"
}
},
"title": "Cisco Em"
},
"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"
},
"pexip": {
"type": "object",
"properties": {
"qa_delete": {
"type": "string",
"title": "Delete"
},
"name": {
"type": "string",
"title": "Account Name"
},
"qa_edit": {
"type": "string",
"title": "Edit"
},
"pexip_user_data": {
"type": "string",
"title": "Pexip User Data"
},
"ConferenceAlias": {
"type": "string",
"title": "Aliases"
},
"pexip_user": {
"type": "string",
"title": "Pexip User"
},
"pexip_user_link": {
"format": "link",
"type": "string",
"title": "Pexip User"
},
"qa_add": {
"type": "string",
"title": "Add"
},
"primary_owner_email_address": {
"type": "string",
"title": "Primary Owner Email Address"
}
},
"title": "Pexip"
},
"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"
},
"mseo": {
"type": "object",
"properties": {
"ms_user": {
"type": "string",
"title": "Microsoft User"
},
"ms_user_link": {
"format": "link",
"type": "string",
"title": "Microsoft User"
},
"enabled": {
"type": "string",
"title": "Exchange Enabled"
},
"ms_user_data": {
"type": "string",
"title": "Microsoft User Data"
},
"qa_mseo_add": {
"type": "string",
"title": "Add"
},
"qa_mseo_edit": {
"type": "string",
"title": "Edit"
},
"CalendarPermissions": {
"type": "string",
"title": "Calendar Permissions"
},
"ms_user_pkid": {
"type": "string",
"title": "Microsoft User PKID"
},
"Permissions": {
"type": "string",
"title": "Permissions"
}
},
"title": "Mseo"
},
"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"
},
"cisco_webex": {
"type": "object",
"properties": {
"qa_delete": {
"type": "string",
"title": "Delete"
},
"associated_webex": {
"type": "string",
"title": "Associated WebEx User Data"
},
"qa_edit": {
"type": "string",
"title": "Edit"
},
"cucm_user": {
"type": "string",
"title": "Cisco CUCM User"
},
"active": {
"type": "string",
"title": "Active"
},
"qa_add": {
"type": "string",
"title": "Add"
},
"email": {
"type": "string",
"title": "Email"
}
},
"title": "Cisco Webex"
},
"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"
},
"msucs": {
"type": "object",
"properties": {
"azure_user_data": {
"type": "string",
"title": "Microsoft Azure Data"
},
"ucs": {
"type": "object",
"properties": {
"SimultaneousSettings": {
"type": "object",
"properties": {
"SimultaneousUnansweredOption": {
"type": "string",
"title": "If unanswered"
},
"SimultaneousOption": {
"type": "string",
"title": "Also allow"
}
},
"title": "Ring device settings"
},
"CallAnsweringRuleOption": {
"type": "string",
"title": "Call Answering Rules"
}
},
"title": "Settings"
},
"ms_user": {
"type": "string",
"title": "Microsoft User"
},
"ms_user_link": {
"format": "link",
"type": "string",
"title": "Microsoft User"
},
"ms_user_data": {
"type": "string",
"title": "Microsoft User Data"
},
"OnlineDialOutPolicy": {
"type": "string",
"title": "Outbound calling"
},
"qa_msucs_add": {
"type": "string",
"title": "Add"
},
"qa_msucs_delete": {
"type": "string",
"title": "Delete"
},
"ms_user_pkid": {
"type": "string",
"title": "Microsoft User PKID"
},
"qa_msucs_edit": {
"type": "string",
"title": "Edit"
}
},
"title": "Msucs"
}
},
"schema_version": "1.2.7"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/MultiVendorSubscriber/add/ |
|
The GUI Add form of relation/MultiVendorSubscriber 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/MultiVendorSubscriber | 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/relation/MultiVendorSubscriber/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/MultiVendorSubscriber/[pkid1]", "/api/relation/MultiVendorSubscriber/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/MultiVendorSubscriber/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/MultiVendorSubscriber; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/MultiVendorSubscriber/export/ |
|
{ "hrefs":["/api/relation/MultiVendorSubscriber/[pkid1]", "/api/relation/MultiVendorSubscriber/[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 relation/MultiVendorSubscriber and the JSON format can be used to import instances of relation/MultiVendorSubscriber.
GET http://[host-proxy]/api/relation/MultiVendorSubscriber/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/MultiVendorSubscriber | POST | /api/relation/MultiVendorSubscriber/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/relation/MultiVendorSubscriber/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/MultiVendorSubscriber/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/MultiVendorSubscriber/ |
|
The relation/MultiVendorSubscriber schema and all instances as JSON. |
(The list will return 0 to 3 relation/MultiVendorSubscriber instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "username",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/MultiVendorSubscriber/?skip=0&limit=3&order_by=username&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 283
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "1.2.7",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/MultiVendorSubscriber/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/MultiVendorSubscriber/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/MultiVendorSubscriber/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/MultiVendorSubscriber/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/MultiVendorSubscriber/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/relation/MultiVendorSubscriber/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/relation/MultiVendorSubscriber/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/MultiVendorSubscriber/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/MultiVendorSubscriber/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/MultiVendorSubscriber",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"export"
],
"summary_attrs": [
{
"name": "username",
"title": "User Name"
},
{
"name": "first_name",
"title": "First Name"
},
{
"name": "last_name",
"title": "Last Name"
},
{
"name": "email",
"title": "Email Address"
},
{
"name": "role",
"title": "Role"
},
{
"name": "entitlement_profile",
"title": "Entitlement Profile"
},
{
"name": "sync_source",
"title": "Sync Source"
},
{
"name": "sync_type",
"title": "Sync Type"
},
{
"name": "user_type",
"title": "User Type"
},
{
"name": "auth_method",
"title": "Auth Method"
},
{
"name": "department",
"title": "Department"
},
{
"name": "telephone_number",
"title": "Telephone Number"
},
{
"name": "language",
"title": "Language"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "account_information.locked",
"title": "Locked"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "account_information.disabled",
"title": "Disabled"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "602fa141ce894e0011e7bead",
"meta": {
"tags": [],
"cached": true,
"title": "#username",
"business_key": {
"hierarchy": true,
"unique": [
"username"
]
},
"schema_version": "1.1.4",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "602fa141ce894e0011e7bead",
"href": "/api/relation/MultiVendorSubscriber/602fa141ce894e0011e7bead/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": [
{
"pkid": "5f3ae55bce894e00120539d1",
"path": "role",
"model_type": "data/Role"
},
{
"pkid": "5df34f15ce894e0012c600bb",
"path": "language",
"model_type": "data/Language"
},
{
"pkid": "5f3ae56fce894e0012054339",
"path": "entitlement_profile",
"model_type": "data/HcsEntitlementProfileDAT"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/MultiVendorSubscriber/602fa141ce894e0011e7bead/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/MultiVendorSubscriber/602fa141ce894e0011e7bead/",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/MultiVendorSubscriber/602fa141ce894e0011e7bead/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/MultiVendorSubscriber/602fa141ce894e0011e7bead/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/MultiVendorSubscriber/602fa141ce894e0011e7bead/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/MultiVendorSubscriber",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"602fa141ce894e0011e7bead"
],
"summary_attrs": [
{
"name": "username",
"title": "User Name"
},
{
"name": "first_name",
"title": "First Name"
},
{
"name": "last_name",
"title": "Last Name"
},
{
"name": "email",
"title": "Email Address"
},
{
"name": "role",
"title": "Role"
},
{
"name": "entitlement_profile",
"title": "Entitlement Profile"
},
{
"name": "sync_source",
"title": "Sync Source"
},
{
"name": "sync_type",
"title": "Sync Type"
},
{
"name": "user_type",
"title": "User Type"
},
{
"name": "auth_method",
"title": "Auth Method"
},
{
"name": "department",
"title": "Department"
},
{
"name": "telephone_number",
"title": "Telephone Number"
},
{
"name": "language",
"title": "Language"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "account_information.locked",
"title": "Locked"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "account_information.disabled",
"title": "Disabled"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"username": "#username",
"first_name": "#user",
"last_name": "#ln",
"display_name": "#user #ln",
"sync_type": "CUCM-LDAP",
"language": "en-us",
"pkid": "602fa142ce894e0011e7bef9",
"entitlement_profile": "[\"AB_Group-Standard-EP\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"user_type": "End User",
"auth_method": "Automatic",
"exclude_from_directory": false,
"role": "AB_GroupSelfService",
"sync_source": "CUCM",
"hierarchy_friendly_name": "AB_Group (Customer)",
"set_language": true,
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
},
{
"pkid": "655efd8540d96fe47c2508b3",
"meta": {
"tags": [],
"cached": true,
"title": "00055",
"business_key": {
"hierarchy": true,
"unique": [
"username"
]
},
"schema_version": "1.1.4",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "655efd8540d96fe47c2508b3",
"href": "/api/relation/MultiVendorSubscriber/655efd8540d96fe47c2508b3/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": [
{
"pkid": "5f3ae55bce894e00120539d1",
"path": "role",
"model_type": "data/Role"
},
{
"pkid": "5df34f15ce894e0012c600bb",
"path": "language",
"model_type": "data/Language"
},
{
"pkid": "6130ccd7e04a4a00161b8d81",
"path": "sync_source",
"model_type": "data/UserSyncSource"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/relation/MultiVendorSubscriber/655efd8540d96fe47c2508b3/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/relation/MultiVendorSubscriber/655efd8540d96fe47c2508b3/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/MultiVendorSubscriber/655efd8540d96fe47c2508b3/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/relation/MultiVendorSubscriber/655efd8540d96fe47c2508b3/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/relation/MultiVendorSubscriber/655efd8540d96fe47c2508b3/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "relation/MultiVendorSubscriber",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"655efd8540d96fe47c2508b3"
],
"summary_attrs": [
{
"name": "username",
"title": "User Name"
},
{
"name": "first_name",
"title": "First Name"
},
{
"name": "last_name",
"title": "Last Name"
},
{
"name": "email",
"title": "Email Address"
},
{
"name": "role",
"title": "Role"
},
{
"name": "entitlement_profile",
"title": "Entitlement Profile"
},
{
"name": "sync_source",
"title": "Sync Source"
},
{
"name": "sync_type",
"title": "Sync Type"
},
{
"name": "user_type",
"title": "User Type"
},
{
"name": "auth_method",
"title": "Auth Method"
},
{
"name": "department",
"title": "Department"
},
{
"name": "telephone_number",
"title": "Telephone Number"
},
{
"name": "language",
"title": "Language"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "account_information.locked",
"title": "Locked"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "account_information.disabled",
"title": "Disabled"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"username": "00055",
"last_name": "00055",
"customBoolean10": false,
"ldap_server": "",
"user_type": "End User",
"ldap_username": "",
"manager": "",
"customString10": "",
"postal_code": "",
"customString7": "",
"hierarchy_friendly_name": "AB_Group (Customer)",
"object_class": [
"top",
"person",
"organizationalPerson",
"user"
],
"building_name": "",
"city": "",
"first_name": "sbrload00055",
"jabber_id": "",
"display_name": "sbrload00055 S. 00055",
"sync_type": "LDAP",
"title": "Support",
"pkid": "655efd8540d96fe47c250916",
"state": "",
"role": "AB_GroupSelfService",
"department": "IT",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group",
"customString3": "",
"customString2": "",
"customString1": "",
"physical_delivery_office_name": "",
"customString6": "",
"customString5": "",
"customString4": "",
"customString9": "",
"customString8": "",
"sso_username": "",
"language": "en-us",
"customBoolean4": false,
"sync_source": "LDAP",
"employee_type": "",
"auth_method": "Automatic",
"sso_idp": "",
"photo_url": "",
"customBoolean7": false,
"customBoolean6": false,
"customBoolean5": false,
"exclude_from_directory": false,
"customBoolean3": false,
"customBoolean2": false,
"customBoolean1": false,
"country": "",
"employee_number": "S00055",
"customBoolean9": false,
"customBoolean8": false,
"street": "",
"organization": "",
"unverified_mailbox": "",
"set_language": false
}
},
{
"pkid": "655efda040d96fe47c2514d6",
"meta": {
"tags": [],
"cached": true,
"title": "00060",
"business_key": {
"hierarchy": true,
"unique": [
"username"
]
},
"schema_version": "1.1.4",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "655efda040d96fe47c2514d6",
"href": "/api/relation/MultiVendorSubscriber/655efda040d96fe47c2514d6/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": [
{
"pkid": "5f3ae55bce894e00120539d1",
"path": "role",
"model_type": "data/Role"
},
{
"pkid": "5df34f15ce894e0012c600bb",
"path": "language",
"model_type": "data/Language"
},
{
"pkid": "6130ccd7e04a4a00161b8d81",
"path": "sync_source",
"model_type": "data/UserSyncSource"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/relation/MultiVendorSubscriber/655efda040d96fe47c2514d6/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/relation/MultiVendorSubscriber/655efda040d96fe47c2514d6/",
"class": "delete",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/relation/MultiVendorSubscriber/655efda040d96fe47c2514d6/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/relation/MultiVendorSubscriber/655efda040d96fe47c2514d6/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/relation/MultiVendorSubscriber/655efda040d96fe47c2514d6/help",
"class": "help",
"title": "Help"
}
}
],
"model_type": "relation/MultiVendorSubscriber",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"655efda040d96fe47c2514d6"
],
"summary_attrs": [
{
"name": "username",
"title": "User Name"
},
{
"name": "first_name",
"title": "First Name"
},
{
"name": "last_name",
"title": "Last Name"
},
{
"name": "email",
"title": "Email Address"
},
{
"name": "role",
"title": "Role"
},
{
"name": "entitlement_profile",
"title": "Entitlement Profile"
},
{
"name": "sync_source",
"title": "Sync Source"
},
{
"name": "sync_type",
"title": "Sync Type"
},
{
"name": "user_type",
"title": "User Type"
},
{
"name": "auth_method",
"title": "Auth Method"
},
{
"name": "department",
"title": "Department"
},
{
"name": "telephone_number",
"title": "Telephone Number"
},
{
"name": "language",
"title": "Language"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "account_information.locked",
"title": "Locked"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "account_information.disabled",
"title": "Disabled"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"username": "00060",
"last_name": "00060",
"customBoolean10": false,
"ldap_server": "",
"user_type": "End User",
"ldap_username": "",
"manager": "",
"customString10": "",
"postal_code": "",
"customString7": "",
"hierarchy_friendly_name": "AB_Group (Customer)",
"object_class": [
"top",
"person",
"organizationalPerson",
"user"
],
"building_name": "",
"city": "",
"first_name": "sbrload00060",
"jabber_id": "",
"display_name": "sbrload00060 S. 00060",
"sync_type": "LDAP",
"title": "Support",
"pkid": "655efda140d96fe47c25153e",
"state": "",
"role": "AB_GroupSelfService",
"department": "IT",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group",
"customString3": "",
"customString2": "",
"customString1": "",
"physical_delivery_office_name": "",
"customString6": "",
"customString5": "",
"customString4": "",
"customString9": "",
"customString8": "",
"sso_username": "",
"language": "en-us",
"customBoolean4": false,
"sync_source": "LDAP",
"employee_type": "",
"auth_method": "Automatic",
"sso_idp": "",
"photo_url": "",
"customBoolean7": false,
"customBoolean6": false,
"customBoolean5": false,
"exclude_from_directory": false,
"customBoolean3": false,
"customBoolean2": false,
"customBoolean1": false,
"country": "",
"employee_number": "S00060",
"customBoolean9": false,
"customBoolean8": false,
"street": "",
"organization": "",
"unverified_mailbox": "",
"set_language": false
}
}
]
}
(Show the first instance)
{
"pkid": "602fa141ce894e0011e7bead",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "#username",
"business_key": {},
"schema_version": "1.2.7",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": "602fa141ce894e0011e7bead",
"href": "/api/relation/MultiVendorSubscriber/602fa141ce894e0011e7bead/"
}
],
"children": [],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/MultiVendorSubscriber/602fa141ce894e0011e7bead/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/MultiVendorSubscriber/602fa141ce894e0011e7bead/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/MultiVendorSubscriber/602fa141ce894e0011e7bead/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/MultiVendorSubscriber/602fa141ce894e0011e7bead/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/MultiVendorSubscriber/602fa141ce894e0011e7bead/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/MultiVendorSubscriber",
"summary_attrs": [
{
"name": "username",
"title": "User Name"
},
{
"name": "first_name",
"title": "First Name"
},
{
"name": "last_name",
"title": "Last Name"
},
{
"name": "email",
"title": "Email Address"
},
{
"name": "role",
"title": "Role"
},
{
"name": "entitlement_profile",
"title": "Entitlement Profile"
},
{
"name": "sync_source",
"title": "Sync Source"
},
{
"name": "sync_type",
"title": "Sync Type"
},
{
"name": "user_type",
"title": "User Type"
},
{
"name": "auth_method",
"title": "Auth Method"
},
{
"name": "department",
"title": "Department"
},
{
"name": "telephone_number",
"title": "Telephone Number"
},
{
"name": "language",
"title": "Language"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "account_information.locked",
"title": "Locked"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "account_information.disabled",
"title": "Disabled"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"username": "#username",
"first_name": "#user",
"last_name": "#ln",
"display_name": "#user #ln",
"sync_type": "CUCM-LDAP",
"language": "en-us",
"entitlement_profile": "[\"AB_Group-Standard-EP\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"user_type": "End User",
"auth_method": "Automatic",
"exclude_from_directory": false,
"role": "AB_GroupSelfService",
"sync_source": "CUCM",
"set_language": true
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/MultiVendorSubscriber. | GET | /api/relation/MultiVendorSubscriber/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/MultiVendorSubscriber as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/MultiVendorSubscriber/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/MultiVendorSubscriber/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/MultiVendorSubscriber; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/MultiVendorSubscriber/[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 relation/MultiVendorSubscriber and the JSON format can be used to import instances of relation/MultiVendorSubscriber.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/MultiVendorSubscriber/[pkid] | hierarchy=[hierarchy] | The relation/MultiVendorSubscriber instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/MultiVendorSubscriber/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/MultiVendorSubscriber. |