[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": {
"username": {
"required": true,
"type": "string",
"description": "User's Username.",
"title": "User Name"
},
"email": {
"required": false,
"type": "string",
"description": "The User email address.",
"title": "Email Address"
},
"first_name": {
"type": "string",
"description": "The User first name.",
"title": "First Name"
},
"last_name": {
"type": "string",
"description": "The User last name.",
"title": "Last Name"
},
"password": {
"is_password": true,
"description": "The User password.",
"title": "Password",
"pattern": ".{8,}",
"type": "string",
"store_encrypted": true
},
"role": {
"description": "The role to which the user belongs. See: Role.",
"format": "uri",
"required": true,
"target_attr": "name",
"target": "/api/data/Role/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Role",
"type": "string",
"target_model_type": "data/Role",
"choices": []
},
"language": {
"description": "The preferred language for this user.",
"format": "uri",
"default": "en-us",
"required": false,
"target_attr": "lcid",
"target": "/api/data/Language/choices/?field=lcid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Language",
"type": "string",
"target_model_type": "data/Language",
"choices": []
},
"set_language": {
"description": "Indicate if the user's language is set by language default in the hierarchy.",
"title": "Set by Default Language",
"default": false,
"required": false,
"type": "boolean"
},
"account_information": {
"description": "Additional account information for the given user.",
"title": "Account Information",
"required": false,
"type": "object",
"properties": {
"change_password_on_login": {
"required": false,
"type": "boolean",
"description": "Indicates if the user must be forced to change their password the next time that login.",
"title": "Change Password on Next Login"
},
"locked": {
"required": false,
"type": "boolean",
"description": "Indicates if the account has been locked to prevent the user from logging in.",
"title": "Locked"
},
"disabled": {
"required": false,
"type": "boolean",
"description": "Indicates if the account has been disabled to prevent the user from logging in until an administrator enables the account again.",
"title": "Disabled"
},
"reason_for_disabled": {
"required": false,
"type": "string",
"description": "A description of why the account is disabled.",
"title": "Reason for Disabled"
},
"credential_policy": {
"description": "Specifies the policy with the rules used to govern this user's credentials.",
"format": "uri",
"required": false,
"target_attr": "name",
"target": "/api/data/CredentialPolicy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Credential Policy",
"type": "string",
"target_model_type": "data/CredentialPolicy",
"choices": []
},
"failed_login_lock_date": {
"description": "The time when the user account was locked as result of the number of failed login attempts exceeding the permitted thresholds.",
"format": "date-time",
"required": false,
"title": "Time Locked Due to Failed Login Attempts",
"type": "string"
},
"password_last_change_time": {
"description": "The time when the password was last changed.",
"format": "date-time",
"required": false,
"readonly": true,
"title": "Time of Last Password Change",
"type": "string"
},
"password_last_change_time_by_user": {
"description": "The time when the password was last changed by the user.",
"format": "date-time",
"required": false,
"readonly": true,
"title": "Time of Last Password Change By User",
"type": "string"
},
"last_login_time": {
"description": "The time the user last logged in successfully.",
"format": "date-time",
"required": false,
"readonly": true,
"title": "Time of Last Successful Login",
"type": "string"
},
"num_of_failed_login_attempts": {
"description": "The total number of failed login attempts since last successful login.",
"title": "Number of Failed Login Attempts Since Last Successful Login",
"default": "0",
"required": false,
"type": "integer"
},
"security_questions": {
"items": {
"type": "object",
"properties": {
"question": {
"title": "Question",
"required": true,
"displayable": true,
"maxLength": 128,
"type": "string"
},
"answer": {
"maxLength": 128,
"required": true,
"type": "string",
"title": "Answer"
}
}
},
"type": "array",
"title": "Security Questions"
},
"used_passwords": {
"items": {
"type": "object",
"properties": {
"password": {
"type": "string",
"description": "Used password",
"title": "Password"
},
"time_created": {
"type": "string",
"description": "Time when password was created.",
"title": "Time Created"
}
}
},
"type": "array",
"description": "List of passwords that have been used by user.",
"title": "Used Passwords"
}
}
},
"entitlement_profile": {
"is_password": false,
"format": "uri",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"title": "Entitlement Profile",
"type": "string",
"target": "/api/data/HcsEntitlementProfileDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HcsEntitlementProfileDAT",
"choices": []
},
"sync_source": {
"target": "/api/data/UserSyncSource/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"default": "LOCAL",
"title": "Sync Source",
"target_attr": "name",
"type": "string",
"description": "Sync source of the user. Identifies where the user was synced from. This value will determine the master of the data. The data in the User model will be derived from the fields of the master application (E.G. CUCM, CUC, MS-LDAP).",
"target_model_type": "data/UserSyncSource",
"choices": []
},
"sync_type": {
"default": "LOCAL",
"type": "string",
"description": "Sync type of the user. Identifies the user type that was synced from device as indicated by Sync Source information, e.g. CUCM-Local, CUCM-LDAP, LOCAL.",
"title": "Sync Type"
},
"building_name": {
"type": "string",
"description": "Building name or number.",
"title": "Building Name"
},
"country": {
"type": "string",
"description": "Country name.",
"title": "Country"
},
"department": {
"type": "string",
"description": "Department names and numbers.",
"title": "Department"
},
"directory_uri": {
"type": "string",
"description": "Alphanumeric Directory URI (e.g. SIP URI)",
"title": "Directory URI"
},
"display_name": {
"type": "string",
"description": "Display name of the user",
"title": "Display Name"
},
"employee_number": {
"type": "string",
"description": "Employee number of the user",
"title": "Employee Number"
},
"employee_type": {
"type": "string",
"description": "Employee type",
"title": "Employee Type"
},
"facsimile_telephone_number": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's facsimile telephone Number(s).",
"title": "Facsimile Telephone Number"
},
"home_phone": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's home phone number(s).",
"title": "Home Phone"
},
"ip_phone": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's IP phone number(s).",
"title": "IP Phone"
},
"jabber_id": {
"type": "string",
"description": "Jabber ID",
"title": "Jabber ID"
},
"city": {
"type": "string",
"description": "Contains the name of a person's locality.",
"title": "City"
},
"manager": {
"type": "string",
"description": "Manager.",
"title": "Manager"
},
"member_of": {
"items": {
"type": "string"
},
"type": "array",
"description": "The user can be a member of a variety of groups.",
"title": "Member Of"
},
"mobile": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's IP mobile number(s).",
"title": "Mobile"
},
"organization": {
"type": "string",
"description": "The name of the person's organization.",
"title": "Organization"
},
"object_class": {
"minItems": 0,
"items": {
"is_password": false,
"type": "string"
},
"type": "array",
"title": "Object Class"
},
"other_mailbox": {
"minItems": 0,
"items": {
"is_password": false,
"type": "string"
},
"type": "array",
"title": "Other Mailbox"
},
"ou": {
"description": "The name of the person's organization unit.",
"title": "Organizational Unit",
"minItems": 0,
"items": {
"is_password": false,
"type": "string"
},
"type": "array"
},
"photo_url": {
"type": "string",
"description": "Photo URL.",
"title": "Photo URL"
},
"physical_delivery_office_name": {
"type": "string",
"description": "Physical Delivery Office Name.",
"title": "Physical Delivery Office Name"
},
"postal_code": {
"type": "string",
"description": "Contains code used by a Postal Service to identify postal service zones.",
"title": "Postal Code"
},
"preferred_language": {
"type": "string",
"description": "Preferred Language.",
"title": "Preferred Language"
},
"state": {
"type": "string",
"description": "Contains full names of state or province.",
"title": "State"
},
"street": {
"type": "string",
"description": "Contains site information from a postal address.",
"title": "Street"
},
"telephone_number": {
"items": {
"type": "string"
},
"type": "array",
"description": "Telephone Number.",
"title": "Telephone Number"
},
"timezone": {
"type": "string",
"description": "Timezone.",
"title": "Timezone"
},
"title": {
"type": "string",
"description": "Title.",
"title": "Title"
},
"unverified_mailbox": {
"type": "string",
"description": "Unverified Mail Box.",
"title": "Unverified Mail Box"
},
"customString1": {
"type": "string",
"description": "Custom String",
"title": "Custom String 1"
},
"customString2": {
"type": "string",
"description": "Custom String",
"title": "Custom String 2"
},
"customString3": {
"type": "string",
"description": "Custom String",
"title": "Custom String 3"
},
"customString4": {
"type": "string",
"description": "Custom String",
"title": "Custom String 4"
},
"customString5": {
"type": "string",
"description": "Custom String",
"title": "Custom String 5"
},
"customString6": {
"type": "string",
"description": "Custom String",
"title": "Custom String 6"
},
"customString7": {
"type": "string",
"description": "Custom String",
"title": "Custom String 7"
},
"customString8": {
"type": "string",
"description": "Custom String",
"title": "Custom String 8"
},
"customString9": {
"type": "string",
"description": "Custom String",
"title": "Custom String 9"
},
"customString10": {
"type": "string",
"description": "Custom String",
"title": "Custom String 10"
},
"customListOfStrings1": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 1"
},
"customListOfStrings2": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 2"
},
"customListOfStrings3": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 3"
},
"customListOfStrings4": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 4"
},
"customListOfStrings5": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 5"
},
"customListOfStrings6": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 6"
},
"customListOfStrings7": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 7"
},
"customListOfStrings8": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 8"
},
"customListOfStrings9": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 9"
},
"customListOfStrings10": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 10"
},
"customBoolean1": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 1"
},
"customBoolean2": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 2"
},
"customBoolean3": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 3"
},
"customBoolean4": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 4"
},
"customBoolean5": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 5"
},
"customBoolean6": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 6"
},
"customBoolean7": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 7"
},
"customBoolean8": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 8"
},
"customBoolean9": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 9"
},
"customBoolean10": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 10"
},
"auth_method": {
"description": "The type of authentication that our user would be using. Typically this would be choices between a Standard VOSS 4 UC user, an LDAP user or an SSO user.",
"title": "Auth Method",
"default": "Local",
"choices": [
{
"value": "Local",
"title": "Local"
},
{
"value": "Automatic",
"title": "Automatic"
},
{
"value": "LDAP",
"title": "LDAP"
},
{
"value": "SSO",
"title": "SSO"
}
],
"type": "string"
},
"ldap_server": {
"description": "A reference to the LDAP server which this user must authenticate against.",
"format": "uri",
"required": false,
"target": "/api/data/Ldap/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "LDAP Server",
"type": "string",
"target_model_type": "data/Ldap",
"choices": []
},
"ldap_username": {
"type": "string",
"description": "The login attribute of the associated LDAP device model instance",
"title": "LDAP Username"
},
"sso_idp": {
"description": "The entity id of the SSO Identity Provider.",
"format": "uri",
"required": false,
"target_attr": "entity_id",
"target": "/api/data/SsoIdentityProvider/choices/?field=entity_id&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "SSO Identity Provider",
"type": "string",
"target_model_type": "data/SsoIdentityProvider",
"choices": []
},
"sso_username": {
"required": false,
"type": "string",
"description": "The name identifier that is used for an SSO authenticated user.",
"title": "SSO Username"
},
"user_type": {
"description": "Indicate the user's login type.",
"title": "User Type",
"default": "Admin",
"required": false,
"choices": [
{
"value": "Admin",
"title": "Admin"
},
{
"value": "End User",
"title": "End User"
},
{
"value": "End User + Admin",
"title": "End User + Admin"
}
],
"type": "string"
},
"exclude_from_directory": {
"type": "boolean",
"description": "Exclude from Directory flag to control the Phone Services directory lookup. If set to true the User's phone number will not appear in the directory lookup.",
"title": "Exclude from Directory"
},
"mvs_hybrid_status": {
"required": false,
"type": "string",
"title": "Hybrid Status"
},
"mvs_primary_line": {
"type": "string",
"title": "Primary Line"
},
"mvs_primary_line_cos": {
"type": "string",
"title": "Primary Class of Service"
},
"mvs_extensions": {
"description": "Extensions to select primary details from.",
"title": "Extensions",
"items": {
"type": "object",
"properties": {
"line": {
"type": "string",
"title": "Line"
},
"line_e164": {
"type": "string",
"title": "Line E164"
},
"line_cos": {
"type": "string",
"title": "Class of Service"
}
}
},
"required": false,
"type": "array"
},
"username_avaya_system_manager": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Avaya System Manager.",
"title": "Avaya System Manager User Name"
},
"username_broadworks": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Broadworks.",
"title": "Broadworks User Name"
},
"username_cuc": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Cisco Unity Connection.",
"title": "Cisco Unity Connection User Name"
},
"username_cucm": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Cisco Unified Communication Manager.",
"title": "Cisco Unified Communication Manager User Name"
},
"username_hcmf": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Cisco HCMF.",
"title": "HCMF User Name"
},
"username_ldap": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in the LDAP Directory.",
"title": "LDAP Directory User Name"
},
"username_microsoft": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Microsoft Username.",
"title": "Microsoft User Name"
},
"username_ms_365": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Microsoft Office 365.",
"title": "Microsoft Office 365 User Name"
},
"username_ms_ldap": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Microsoft LDAP.",
"title": "Microsoft LDAP User Name"
},
"username_ms_teams": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Microsoft Teams.",
"title": "Microsoft Teams User Name"
},
"username_open_ldap": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Opoen LDAP.",
"title": "Open LDAP User Name"
},
"username_uccx": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Cisco Unified Contact Centre Express.",
"title": "Cisco Unified Contact Centre Express User Name"
},
"username_webex_teams": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Webex App.",
"title": "Webex App User Name"
},
"username_zoom": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Zoom.",
"title": "Zoom User Name"
},
"authorized_admin_hierarchy": {
"description": "A reference an Authorized Admin Hierarchy instance that defines this user's administrative capabilities. This enables administrative capabilities for end users.",
"format": "uri",
"required": false,
"target_attr": "name",
"target": "/api/data/AuthorizedAdminHierarchy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Authorized Admin Hierarchy",
"type": "string",
"target_model_type": "data/AuthorizedAdminHierarchy",
"choices": []
},
"license_audit_details": {
"description": "License Audit Information.",
"title": "License Audit Details",
"required": false,
"type": "object",
"properties": {
"last_checked": {
"description": "The last time the License Audit Details were updated.",
"format": "date-time",
"required": false,
"readonly": true,
"title": "Last Checked",
"type": "string"
},
"status": {
"description": "The License Audit status of the user.",
"title": "License Audit Status",
"default": "Unknown",
"required": false,
"choices": [
{
"value": "Licensed",
"title": "Licensed"
},
{
"value": "Unlicensed",
"title": "Unlicensed"
},
{
"value": "Unknown",
"title": "Unknown"
}
],
"readonly": true,
"type": "string"
}
}
},
"mvs_user": {
"title": "Mvs User",
"type": "object",
"properties": {
"username": {
"title": "VOSS User",
"type": "string"
},
"enabled_services": {
"title": "Enabled Services",
"type": "string"
},
"discovered_services": {
"title": "Discovered Services",
"type": "string"
},
"discovered_apps": {
"title": "Discovered Applications",
"type": "string"
},
"line": {
"title": "VOSS User Line",
"type": "string"
},
"line_by_pattern": {
"title": "VOSS User Line by pattern",
"type": "string"
},
"associated_lines": {
"title": "VOSS User Associated Lines",
"type": "string"
},
"associated_phones": {
"title": "Associated Phones",
"type": "string"
},
"associated_profiles": {
"title": "Associated Profiles",
"type": "string"
},
"associated_cucm_user": {
"title": "Associated Cucm User",
"type": "string"
},
"associated_rdp": {
"title": "Associated SNR",
"type": "string"
},
"associated_vm": {
"title": "Associated VM",
"type": "string"
},
"associated_webex": {
"title": "Associated WebEx",
"type": "string"
},
"associated_webexapp_user": {
"title": "Associated Webex App User",
"type": "string"
},
"associated_webexapp_user_config": {
"title": "Associated Webex App User Config",
"type": "string"
},
"associated_headset": {
"title": "Associated Headset",
"type": "string"
},
"associated_ms": {
"title": "Associated Microsoft User Data",
"type": "string"
},
"ms_user_pkid": {
"title": "Associated Microsoft User PKID",
"type": "string"
},
"ms_teams_user_pkid": {
"title": "Associated Microsoft Teams User PKID",
"type": "string"
},
"cucm_user_pkid": {
"title": "Associated CUCM User PKID",
"type": "string"
},
"located_at": {
"title": "VOSS User Located at",
"type": "string"
},
"associated_ccx": {
"title": "Associated CCX",
"type": "string"
},
"associated_pexip": {
"title": "Associated Pexip",
"type": "string"
},
"associated_fdp": {
"title": "Associated FDP",
"type": "string"
},
"ms_ucs_fdp": {
"title": "Microsoft UCS FDP",
"type": "string"
},
"ms_vm_fdp": {
"title": "Microsoft VM FDP",
"type": "string"
}
}
},
"mvs_user_qa": {
"title": "Mvs User Qa",
"type": "object",
"properties": {
"username": {
"title": "VOSS User",
"type": "string"
},
"qa_login_phone": {
"title": "Login Phone",
"type": "string"
},
"qa_logout_phone": {
"title": "Logout Phone",
"type": "string"
},
"qa_update_subscriber_from_profile": {
"title": "Update Subscriber (Profile)",
"type": "string"
},
"qa_cucm_qas": {
"title": "Quick Subscriber (Cisco UCM)",
"type": "string"
},
"qa_ms_qas": {
"title": "Quick Subscriber (MS)",
"type": "string"
},
"qa_webexapp_qas": {
"title": "Quick Subscriber (Webex App)",
"type": "string"
},
"qa_update_cisco_user": {
"title": "Update User (Cisco UCM)",
"type": "string"
},
"qa_move_subscriber": {
"title": "Move Subscriber",
"type": "string"
},
"qa_reassign_services": {
"title": "Reassign Services",
"type": "string"
},
"qa_update_services": {
"title": "Update Services",
"type": "string"
},
"qa_reset_pin_passwd": {
"title": "Reset Pin / Password",
"type": "string"
},
"qa_delete_services": {
"title": "Delete All Services",
"type": "string"
},
"qa_huntgroup_add": {
"title": "Add to Hunt Group",
"type": "string"
},
"qa_huntgroup_del": {
"title": "Remove from all Hunt Groups",
"type": "string"
},
"qa_cpg_add": {
"title": "Add to Call Pickup Group",
"type": "string"
},
"qa_cpg_del": {
"title": "Remove from all Call Pickup Groups",
"type": "string"
},
"qa_update_group_membership": {
"title": "Update Group Membership",
"type": "string"
},
"qa_refresh": {
"title": "Refresh",
"type": "string"
}
}
},
"cisco_user": {
"title": "Cisco User",
"type": "object",
"properties": {
"username": {
"required": true,
"type": "string",
"title": "VOSS User"
},
"imAndPresenceEnable": {
"required": false,
"type": "boolean",
"title": "IM And Presence Enable"
},
"ipccExtension": {
"required": false,
"type": "string",
"title": "IPCC Extension"
},
"enableUserToHostConferenceNow": {
"required": false,
"type": "boolean",
"title": "Enable User To Host Conference Now"
},
"selfService": {
"readonly": true,
"required": false,
"type": "string",
"title": "Meeting Number"
},
"attendeesAccessCode": {
"required": false,
"type": "string",
"title": "Attendees Access Code "
}
}
},
"cisco_phone": {
"title": "Cisco Phone",
"type": "object",
"properties": {
"cucm_user": {
"type": "string",
"title": "Cisco CUCM User"
},
"cucm_user_link": {
"format": "link",
"type": "string",
"title": "Cisco CUCM User"
},
"cucm_user_data": {
"type": "string",
"title": "Cisco CUCM User Data"
},
"associated_phones": {
"type": "string",
"title": "Associated Phones"
},
"cucm_user_phone_link": {
"format": "link",
"type": "string",
"title": "Cisco CUCM User"
},
"cucm_user_phone_data": {
"type": "string",
"title": "Cisco CUCM Phone Data"
},
"name": {
"type": "string",
"title": "Phone Name"
},
"type": {
"type": "string",
"title": "Phone Type"
},
"lines": {
"type": "string",
"title": "Phone Lines"
},
"qa_add": {
"type": "string",
"title": "Add"
},
"qa_delete": {
"type": "string",
"title": "Delete"
},
"qa_reset": {
"type": "string",
"title": "Reset"
},
"qa_generate_prt": {
"type": "string",
"title": "Generate PRT"
},
"qa_replace": {
"type": "string",
"title": "Replace"
}
}
},
"cisco_jabber": {
"title": "Cisco Jabber",
"type": "object",
"properties": {
"cucm_user": {
"type": "string",
"title": "Cisco CUCM User"
},
"cucm_user_link": {
"format": "link",
"type": "string",
"title": "Cisco CUCM User"
},
"cucm_user_data": {
"type": "string",
"title": "Cisco CUCM User Data"
},
"associated_phones": {
"type": "string",
"title": "Associated Phones"
},
"cucm_user_phone_link": {
"format": "link",
"type": "string",
"title": "Cisco CUCM User"
},
"cucm_user_phone_data": {
"type": "string",
"title": "Cisco CUCM Phone Data"
},
"name": {
"type": "string",
"title": "Phone Name"
},
"type": {
"type": "string",
"title": "Phone Type"
},
"lines": {
"type": "string",
"title": "Phone Lines"
},
"qa_add": {
"type": "string",
"title": "Add"
},
"qa_delete": {
"type": "string",
"title": "Delete"
},
"qa_reset": {
"type": "string",
"title": "Reset"
},
"qa_generate_prt": {
"type": "string",
"title": "Generate PRT"
},
"qa_replace": {
"type": "string",
"title": "Replace"
}
}
},
"cisco_em": {
"title": "Cisco Em",
"type": "object",
"properties": {
"cucm_user": {
"type": "string",
"title": "Cisco CUCM User"
},
"cucm_user_link": {
"format": "link",
"type": "string",
"title": "Cisco CUCM User"
},
"cucm_user_data": {
"type": "string",
"title": "Cisco CUCM User Data"
},
"associated_profiles": {
"type": "string",
"title": "Associated Profiles"
},
"cucm_user_em_link": {
"format": "link",
"type": "string",
"title": "Cisco CUCM EM"
},
"cucm_user_em_data": {
"type": "string",
"title": "Cisco CUCM EM Data"
},
"name": {
"type": "string",
"title": "EM Name"
},
"type": {
"type": "string",
"title": "EM Type"
},
"lines": {
"type": "string",
"title": "EM Lines"
},
"qa_add": {
"type": "string",
"title": "Add"
},
"qa_edit": {
"type": "string",
"title": "Edit"
},
"qa_delete": {
"type": "string",
"title": "Delete"
}
}
},
"cisco_snr": {
"title": "Cisco Snr",
"type": "object",
"properties": {
"cucm_user": {
"type": "string",
"title": "Cisco CUCM User"
},
"cucm_user_link": {
"format": "link",
"type": "string",
"title": "Cisco CUCM User"
},
"cucm_user_data": {
"type": "string",
"title": "Cisco CUCM User Data"
},
"associated_rdp": {
"type": "string",
"title": "Associated SNR"
},
"cucm_user_rdp_link": {
"format": "link",
"type": "string",
"title": "Cisco CUCM User"
},
"cucm_user_rdp_data": {
"type": "string",
"title": "Cisco CUCM RDP Data"
},
"line": {
"type": "string",
"title": "Line"
},
"RemoteDestination": {
"type": "string",
"title": "Mobile Number"
},
"qa_add": {
"type": "string",
"title": "Add"
},
"qa_edit": {
"type": "string",
"title": "Edit"
},
"qa_delete": {
"type": "string",
"title": "Delete"
}
}
},
"cisco_vm": {
"title": "Cisco Vm",
"type": "object",
"properties": {
"cuc_user": {
"type": "string",
"title": "Cisco CUC User"
},
"cuc_user_link": {
"format": "link",
"type": "string",
"title": "Cisco CUC User"
},
"cuc_user_data": {
"type": "string",
"title": "Cisco CUC User Data"
},
"account_number": {
"type": "string",
"title": "VM Account Number"
},
"pin_locked": {
"type": "boolean",
"title": "Admin Locked"
},
"pin_user_locked": {
"type": "boolean",
"title": "User Locked"
},
"cuc_lines": {
"type": "boolean",
"title": "CUC Lines"
},
"qa_add": {
"type": "string",
"title": "Add"
},
"qa_edit": {
"type": "string",
"title": "Edit"
},
"qa_delete": {
"type": "string",
"title": "Delete"
},
"qa_unlock_account": {
"type": "string",
"title": "Unlock Account"
},
"qa_lock_account": {
"type": "string",
"title": "Lock Account"
}
}
},
"cisco_webex": {
"title": "Cisco Webex",
"type": "object",
"properties": {
"cucm_user": {
"type": "string",
"title": "Cisco CUCM User"
},
"associated_webex": {
"type": "string",
"title": "Associated WebEx User Data"
},
"active": {
"type": "string",
"title": "Active"
},
"email": {
"type": "string",
"title": "Email"
},
"qa_edit": {
"type": "string",
"title": "Edit"
},
"qa_delete": {
"type": "string",
"title": "Delete"
},
"qa_add": {
"type": "string",
"title": "Add"
}
}
},
"cisco_webexapp_user": {
"title": "Cisco Webexapp User",
"type": "object",
"properties": {
"cucm_user": {
"type": "string",
"title": "Cisco CUCM User"
},
"associated_webexteam": {
"type": "string",
"title": "Associated Webex Team Data"
},
"loginEnabled": {
"type": "string",
"title": "Login Enabled"
},
"invitePending": {
"type": "string",
"title": "Invite Pending"
},
"licenses": {
"type": "string",
"title": "Licenses"
},
"qa_add": {
"type": "string",
"title": "Add"
},
"qa_edit": {
"type": "string",
"title": "Edit"
},
"qa_delete": {
"type": "string",
"title": "Delete"
}
}
},
"cisco_webexapp_calling": {
"title": "Cisco Webexapp Calling",
"type": "object",
"properties": {
"cucm_user": {
"type": "string",
"title": "Cisco CUCM User"
},
"associated_webexteam": {
"type": "string",
"title": "Associated Webex Team Data"
},
"caller_id": {
"type": "string",
"title": "Caller ID"
},
"voicemail_send": {
"type": "string",
"title": "Voicemail Send"
},
"barge_in": {
"type": "string",
"title": "Barge"
},
"call_forward": {
"type": "string",
"title": "Call Forward"
},
"call_recording": {
"type": "string",
"title": "Call Recording"
},
"call_waiting": {
"type": "string",
"title": "Call Waiting"
},
"call_intercept": {
"type": "string",
"title": "Call Intercept"
},
"qa_add": {
"type": "string",
"title": "Add"
},
"qa_edit": {
"type": "string",
"title": "Edit"
},
"qa_delete": {
"type": "string",
"title": "Delete"
}
}
},
"headset": {
"title": "Headset",
"type": "object",
"properties": {
"cucm_user": {
"type": "string",
"title": "Cisco CUCM User"
},
"headset_vendor": {
"type": "string",
"title": "Vendor"
},
"headset_model": {
"type": "string",
"title": "Model"
},
"host_deviceNameTrimmed": {
"type": "string",
"title": "Connected Device"
},
"headset_connectionType": {
"type": "string",
"title": "Connection Type"
},
"headset_connectionStatus": {
"type": "string",
"title": "Connection Status"
},
"lastChangeTime": {
"type": "string",
"title": "Last Status Update"
},
"headset_firmwareVersion": {
"type": "string",
"title": "Firmware Version"
},
"headset_serialNumber": {
"type": "string",
"title": "Serial Number"
},
"qa_associate": {
"type": "string",
"title": "Associate"
},
"qa_disassociate": {
"type": "string",
"title": "Disassociate"
}
}
},
"cisco_ccx": {
"title": "Cisco Ccx",
"type": "object",
"properties": {
"cucm_user": {
"type": "string",
"title": "Cisco CUCM User"
},
"cucm_user_link": {
"format": "link",
"type": "string",
"title": "Cisco CUCM User"
},
"cucm_user_data": {
"type": "string",
"title": "Cisco CUCM User Data"
},
"extension": {
"type": "string",
"title": "Extension"
},
"type": {
"type": "string",
"title": "User Type"
},
"teamName": {
"type": "string",
"title": "Team Name"
},
"resourceGroupName": {
"type": "string",
"title": "Resource Group"
},
"autoAvailable": {
"type": "string",
"title": "Auto Available"
},
"skills": {
"type": "string",
"title": "Skills"
},
"qa_add": {
"type": "string",
"title": "Add"
},
"qa_edit": {
"type": "string",
"title": "Edit"
},
"qa_delete": {
"type": "string",
"title": "Delete"
}
}
},
"msteam": {
"title": "Msteam",
"type": "object",
"properties": {
"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"
},
"ms_user_pkid": {
"type": "string",
"title": "Microsoft User PKID"
},
"azure_user_data": {
"type": "string",
"title": "Microsoft Azure Data"
},
"ms365": {
"type": "object",
"title": "365",
"properties": {
"PhoneNumber": {
"type": "string",
"title": "Phone Number"
},
"MobileNumber": {
"type": "string",
"title": "Mobile Number"
},
"LocationUsage": {
"type": "string",
"title": "Location Usage"
}
}
},
"mslicenses": {
"type": "object",
"title": "Licenses",
"properties": {
"IsLicensed": {
"type": "string",
"title": "Is Licensed"
},
"AccountSkuId": {
"type": "string",
"title": "License Summary"
}
}
},
"msteams": {
"type": "object",
"title": "Teams",
"properties": {
"UserPrincipalName": {
"type": "string",
"title": "User Principal Name"
},
"AccountEnabled": {
"type": "boolean",
"title": "Account Enabled"
},
"FeatureTypes": {
"items": {
"type": "string"
},
"type": "array",
"title": "Feature Types"
},
"LineURItel": {
"type": "string",
"title": "Line URI"
},
"LineURIType": {
"type": "string",
"title": "Line URI Type"
},
"OnlineVoiceRoutingPolicy": {
"type": "string",
"title": "Online Voice Routing Policy"
},
"TenantDialPlan": {
"type": "string",
"title": "Tenant Dial Plan"
},
"TeamsCallingPolicy": {
"type": "string",
"title": "Teams Calling Policy"
},
"TeamsCallParkPolicy": {
"type": "string",
"title": "Teams Call Park Policy"
},
"TeamsEmergencyCallRoutingPolicy": {
"type": "string",
"title": "Teams Emergency Call Routing Policy"
}
}
},
"qa_msteam_add": {
"type": "string",
"title": "Add"
},
"qa_msteam_edit": {
"type": "string",
"title": "Edit"
},
"qa_msteam_delete": {
"type": "string",
"title": "Delete"
}
}
},
"msucs": {
"title": "Msucs",
"type": "object",
"properties": {
"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"
},
"ms_user_pkid": {
"type": "string",
"title": "Microsoft User PKID"
},
"azure_user_data": {
"type": "string",
"title": "Microsoft Azure Data"
},
"OnlineDialOutPolicy": {
"type": "string",
"title": "Outbound calling"
},
"ucs": {
"type": "object",
"title": "Settings",
"properties": {
"CallAnsweringRuleOption": {
"type": "string",
"title": "Call Answering Rules"
},
"SimultaneousSettings": {
"type": "object",
"title": "Ring device settings",
"properties": {
"SimultaneousOption": {
"type": "string",
"title": "Also allow"
},
"SimultaneousUnansweredOption": {
"type": "string",
"title": "If unanswered"
}
}
}
}
},
"qa_msucs_add": {
"type": "string",
"title": "Add"
},
"qa_msucs_edit": {
"type": "string",
"title": "Edit"
},
"qa_msucs_delete": {
"type": "string",
"title": "Delete"
}
}
},
"msvm": {
"title": "Msvm",
"type": "object",
"properties": {
"ms_user": {
"title": "Microsoft User",
"type": "string"
},
"ms_user_link": {
"title": "Microsoft User",
"type": "string",
"format": "link"
},
"ms_user_data": {
"title": "Microsoft User Data",
"type": "string"
},
"ms_user_pkid": {
"title": "Microsoft User PKID",
"type": "string"
},
"azure_user_data": {
"title": "Microsoft Azure Data",
"type": "string"
},
"VoicemailEnabled": {
"title": "Voicemail Enabled",
"type": "string"
},
"PromptLanguage": {
"title": "Prompt Language",
"type": "string"
},
"CallAnswerRule": {
"title": "Call Answering Mode",
"type": "string"
},
"CallTransferring": {
"title": "Call transferring",
"type": "string"
},
"TransferTargetNumber": {
"title": "Transfer to PSTN number",
"type": "string"
},
"DefaultGreetingPromptOverwrite": {
"title": "Default greeting prompt",
"type": "string"
},
"DefaultOofGreetingPromptOverwrite": {
"title": "Default out of office prompt",
"type": "string"
},
"OofGreetingEnabled": {
"title": "Always play out-of-office greetings",
"type": "string"
},
"OofGreetingFollowAutomaticRepliesEnabled": {
"title": "When sending automatic replies",
"type": "string"
},
"OofGreetingFollowCalendarEnabled": {
"title": "When calendar shows out-of-office",
"type": "string"
},
"qa_msvm_add": {
"title": "Add",
"type": "string"
},
"qa_msvm_edit": {
"title": "Edit",
"type": "string"
},
"qa_msvm_delete": {
"title": "Delete",
"type": "string"
}
}
},
"mso365": {
"title": "Mso365",
"type": "object",
"properties": {
"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"
},
"ms_user_pkid": {
"type": "string",
"title": "Microsoft User PKID"
},
"azure_user_data": {
"type": "string",
"title": "Microsoft Azure Data"
},
"ms365": {
"type": "object",
"title": "365",
"properties": {
"PhoneNumber": {
"type": "string",
"title": "Phone Number"
},
"MobileNumber": {
"type": "string",
"title": "Mobile Number"
},
"LocationUsage": {
"type": "string",
"title": "Location Usage"
}
}
},
"mslicenses": {
"type": "object",
"title": "Licenses",
"properties": {
"IsLicensed": {
"type": "string",
"title": "Is Licensed"
},
"AccountSkuId": {
"type": "string",
"title": "Account SKU ID"
}
}
},
"msteams": {
"type": "object",
"title": "Teams",
"properties": {
"UserPrincipalName": {
"type": "string",
"title": "User Principal Name"
},
"AccountEnabled": {
"type": "boolean",
"title": "Account Enabled"
},
"EnterpriseVoiceEnabled": {
"type": "boolean",
"title": "Enterprise Voice Enabled"
},
"LineURItel": {
"type": "string",
"title": "Line URI"
},
"OnlineVoiceRoutingPolicy": {
"type": "string",
"title": "Online Voice Routing Policy"
},
"TenantDialPlan": {
"type": "string",
"title": "Tenant Dial Plan"
},
"TeamsCallingPolicy": {
"type": "string",
"title": "Teams Calling Policy"
},
"TeamsCallParkPolicy": {
"type": "string",
"title": "Teams Call Park Policy"
},
"TeamsEmergencyCallRoutingPolicy": {
"type": "string",
"title": "Teams Emergency Call Routing Policy"
}
}
},
"qa_mso365_add": {
"type": "string",
"title": "Add"
},
"qa_mso365_edit": {
"type": "string",
"title": "Edit"
},
"qa_mso365_delete": {
"type": "string",
"title": "Delete"
}
}
},
"mseo": {
"title": "Mseo",
"type": "object",
"properties": {
"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"
},
"ms_user_pkid": {
"type": "string",
"title": "Microsoft User PKID"
},
"enabled": {
"type": "string",
"title": "Exchange Enabled"
},
"Permissions": {
"type": "string",
"title": "Permissions"
},
"CalendarPermissions": {
"type": "string",
"title": "Calendar Permissions"
},
"qa_mseo_add": {
"type": "string",
"title": "Add"
},
"qa_mseo_edit": {
"type": "string",
"title": "Edit"
}
}
},
"pexip": {
"title": "Pexip",
"type": "object",
"properties": {
"pexip_user": {
"type": "string",
"title": "Pexip User"
},
"pexip_user_link": {
"format": "link",
"type": "string",
"title": "Pexip User"
},
"pexip_user_data": {
"type": "string",
"title": "Pexip User Data"
},
"name": {
"type": "string",
"title": "Account Name"
},
"ConferenceAlias": {
"type": "string",
"title": "Aliases"
},
"primary_owner_email_address": {
"type": "string",
"title": "Primary Owner Email Address"
},
"qa_add": {
"type": "string",
"title": "Add"
},
"qa_edit": {
"type": "string",
"title": "Edit"
},
"qa_delete": {
"type": "string",
"title": "Delete"
}
}
},
"hybrid_status": {
"title": "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"
}
}
}
},
"schema_version": "1.2.8"
}
| 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)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 264,
"total_limit": null,
"order_by": "username",
"direction": "asc",
"current": "/api/relation/MultiVendorSubscriber/?skip=0&limit=3&order_by=username&direction=asc&traversal=down"
},
"operations": [
"field_display_policy",
"update",
"help",
"remove",
"add",
"configuration_template",
"list",
"export",
"get",
"bulk_update",
"export_bulkload_template"
],
"meta": {
"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"
},
{
"name": "account_information.locked",
"title": "Locked",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "account_information.disabled",
"title": "Disabled",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "license_audit_details.status",
"title": "License Audit Status",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/MultiVendorSubscriber/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"update",
"field_display_policy",
"remove",
"help",
"add",
"configuration_template",
"list",
"export",
"get",
"export_bulkload_template"
],
"schema_version": "1.2.8",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/MultiVendorSubscriber/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/MultiVendorSubscriber/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/MultiVendorSubscriber/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/MultiVendorSubscriber/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/relation/MultiVendorSubscriber/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/relation/MultiVendorSubscriber/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/MultiVendorSubscriber/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/MultiVendorSubscriber/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"last_name": "#ln",
"ldap_server": "",
"user_type": "End User",
"ldap_username": "",
"object_class": [
"top",
"person",
"organizationalPerson",
"user"
],
"first_name": "#user",
"display_name": "#user #ln",
"sync_type": "LDAP",
"entitlement_profile": "[\"AB_Group-Standard-EP\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"role": "AB_GroupSelfService",
"username": "#username",
"sso_username": "",
"sync_source": "LDAP",
"auth_method": "Automatic",
"sso_idp": "",
"exclude_from_directory": false,
"language": "en-us",
"set_language": false,
"license_audit_details": {
"last_checked": "2024-06-25T03:01:36.242Z",
"status": "Unlicensed"
},
"pkid": "650ffdebe5d8a08848bb6f27",
"hierarchy_friendly_name": "AB-DS (IntermediateNode)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-DS"
},
"meta": {
"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"
},
{
"name": "account_information.locked",
"title": "Locked",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "account_information.disabled",
"title": "Disabled",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "license_audit_details.status",
"title": "License Audit Status",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "#username",
"business_key": {
"hierarchy": true,
"unique": [
"username"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89f25affa931cce38d369",
"href": "/api/data/HierarchyNode/5ae89f25affa931cce38d369"
}
],
"foreign_key": [
{
"pkid": "5ae89ea9affa931cce38a78a",
"path": "role",
"model_type": "data/Role"
},
{
"pkid": "5abb9474affa931ce72a74bd",
"path": "language",
"model_type": "data/Language"
},
{
"pkid": "5ae89eb7affa931cce38af7c",
"path": "entitlement_profile",
"model_type": "data/HcsEntitlementProfileDAT"
},
{
"pkid": "650fe39d84eaf2a1ce636bb6",
"path": "sync_source",
"model_type": "data/UserSyncSource"
}
],
"self": [
{
"href": "/api/relation/MultiVendorSubscriber/650ffdebe5d8a08848bb6f1a/",
"pkid": "650ffdebe5d8a08848bb6f1a"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89f25affa931cce38d369",
"650ffdebe5d8a08848bb6f1a"
],
"schema_version": "1.1.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/MultiVendorSubscriber/650ffdebe5d8a08848bb6f1a/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/MultiVendorSubscriber/650ffdebe5d8a08848bb6f1a/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/MultiVendorSubscriber/650ffdebe5d8a08848bb6f1a/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/MultiVendorSubscriber/650ffdebe5d8a08848bb6f1a/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/MultiVendorSubscriber/650ffdebe5d8a08848bb6f1a/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "650ffdebe5d8a08848bb6f1a"
},
{
"data": {
"last_name": "username",
"ldap_server": "",
"user_type": "End User",
"ldap_username": "",
"first_name": "01upn",
"display_name": "01upn username",
"sync_type": "MS_365",
"role": "RNDSelfService",
"email": "[email protected]",
"username": "[email protected]",
"username_ms_teams": "[email protected]",
"username_ms_365": "[email protected]",
"sso_username": "",
"exclude_from_directory": false,
"sync_source": "MS_365",
"auth_method": "Automatic",
"sso_idp": "",
"license_audit_details": {
"last_checked": "2024-06-25T03:01:36.242Z",
"status": "Unlicensed"
},
"language": "en-us",
"set_language": false,
"username_webex_teams": "",
"pkid": "6644eccdf14dbdc7695deab3",
"hierarchy_friendly_name": "RND (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.RND"
},
"meta": {
"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"
},
{
"name": "account_information.locked",
"title": "Locked",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "account_information.disabled",
"title": "Disabled",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "license_audit_details.status",
"title": "License Audit Status",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "[email protected]",
"business_key": {
"hierarchy": true,
"unique": [
"username"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6644e9bcf14dbdc7695d37d1",
"href": "/api/data/HierarchyNode/6644e9bcf14dbdc7695d37d1"
}
],
"foreign_key": [
{
"pkid": "6644e9e0f14dbdc7695d39e8",
"path": "role",
"model_type": "data/Role"
},
{
"pkid": "5abb9474affa931ce72a74bd",
"path": "language",
"model_type": "data/Language"
},
{
"pkid": "650fe39d84eaf2a1ce636b91",
"path": "sync_source",
"model_type": "data/UserSyncSource"
}
],
"self": [
{
"href": "/api/relation/MultiVendorSubscriber/6644ecccf14dbdc7695dea16/",
"pkid": "6644ecccf14dbdc7695dea16"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89bd5affa931cce3863f9",
"6644e9bcf14dbdc7695d37d1",
"6644ecccf14dbdc7695dea16"
],
"schema_version": "1.1.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/MultiVendorSubscriber/6644ecccf14dbdc7695dea16/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/MultiVendorSubscriber/6644ecccf14dbdc7695dea16/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/MultiVendorSubscriber/6644ecccf14dbdc7695dea16/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/MultiVendorSubscriber/6644ecccf14dbdc7695dea16/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/MultiVendorSubscriber/6644ecccf14dbdc7695dea16/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "6644ecccf14dbdc7695dea16"
},
{
"data": {
"ldap_server": "",
"user_type": "End User",
"ldap_username": "",
"display_name": "AA_RA_1",
"sync_type": "MS_365",
"role": "RNDSelfService",
"department": "Microsoft Communication Application Instance",
"email": "[email protected]",
"username": "[email protected]",
"username_ms_teams": "[email protected]",
"username_ms_365": "[email protected]",
"sso_username": "",
"exclude_from_directory": false,
"sync_source": "MS_365",
"auth_method": "Automatic",
"sso_idp": "",
"license_audit_details": {
"last_checked": "2024-06-25T03:01:36.242Z",
"status": "Licensed"
},
"language": "en-us",
"set_language": false,
"username_webex_teams": "",
"pkid": "6644ed32f14dbdc7695e1c0a",
"hierarchy_friendly_name": "RND (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.RND"
},
"meta": {
"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"
},
{
"name": "account_information.locked",
"title": "Locked",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "account_information.disabled",
"title": "Disabled",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "license_audit_details.status",
"title": "License Audit Status",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "[email protected]",
"business_key": {
"hierarchy": true,
"unique": [
"username"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6644e9bcf14dbdc7695d37d1",
"href": "/api/data/HierarchyNode/6644e9bcf14dbdc7695d37d1"
}
],
"foreign_key": [
{
"pkid": "6644e9e0f14dbdc7695d39e8",
"path": "role",
"model_type": "data/Role"
},
{
"pkid": "5abb9474affa931ce72a74bd",
"path": "language",
"model_type": "data/Language"
},
{
"pkid": "650fe39d84eaf2a1ce636b91",
"path": "sync_source",
"model_type": "data/UserSyncSource"
}
],
"self": [
{
"href": "/api/relation/MultiVendorSubscriber/6644ed32f14dbdc7695e1bb6/",
"pkid": "6644ed32f14dbdc7695e1bb6"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89bd5affa931cce3863f9",
"6644e9bcf14dbdc7695d37d1",
"6644ed32f14dbdc7695e1bb6"
],
"schema_version": "1.1.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/MultiVendorSubscriber/6644ed32f14dbdc7695e1bb6/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/MultiVendorSubscriber/6644ed32f14dbdc7695e1bb6/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/MultiVendorSubscriber/6644ed32f14dbdc7695e1bb6/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/MultiVendorSubscriber/6644ed32f14dbdc7695e1bb6/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/MultiVendorSubscriber/6644ed32f14dbdc7695e1bb6/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "6644ed32f14dbdc7695e1bb6"
}
]
}
(Show the first instance)
{
"data": {
"last_name": "#ln",
"ldap_server": "",
"user_type": "End User",
"ldap_username": "",
"object_class": [
"top",
"person",
"organizationalPerson",
"user"
],
"first_name": "#user",
"display_name": "#user #ln",
"sync_type": "LDAP",
"entitlement_profile": "[\"AB_Group-Standard-EP\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"role": "AB_GroupSelfService",
"username": "#username",
"sso_username": "",
"sync_source": "LDAP",
"auth_method": "Automatic",
"sso_idp": "",
"exclude_from_directory": false,
"language": "en-us",
"set_language": false,
"license_audit_details": {
"last_checked": "2024-06-25T03:01:36.242Z",
"status": "Unlicensed"
}
},
"meta": {
"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"
},
{
"name": "account_information.locked",
"title": "Locked",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "account_information.disabled",
"title": "Disabled",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "license_audit_details.status",
"title": "License Audit Status",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "#username",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"children": [],
"parent": [
{
"pkid": "5ae89f25affa931cce38d369",
"href": "/api/data/HierarchyNode/5ae89f25affa931cce38d369"
}
],
"self": [
{
"href": "/api/relation/MultiVendorSubscriber/650ffdebe5d8a08848bb6f1a/",
"pkid": "650ffdebe5d8a08848bb6f1a"
}
]
},
"schema_version": "1.2.8",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/MultiVendorSubscriber/650ffdebe5d8a08848bb6f1a/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/MultiVendorSubscriber/650ffdebe5d8a08848bb6f1a/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/MultiVendorSubscriber/650ffdebe5d8a08848bb6f1a/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/MultiVendorSubscriber/650ffdebe5d8a08848bb6f1a/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/MultiVendorSubscriber/650ffdebe5d8a08848bb6f1a/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "650ffdebe5d8a08848bb6f1a"
}
| 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. |