[Index]
doc
Model ref.: data/MultivendorUsernameMappingMacros
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_macro_cuc": {
"items": {
"type": "string"
},
"required": false,
"type": "array",
"description": "The macro to resolve the VOSS username corresponding to the the Username in Cisco Unity Connection.",
"title": "Cisco Unity Connection User Name"
},
"username_macro_uccx": {
"items": {
"type": "string"
},
"required": false,
"type": "array",
"description": "The macro to resolve the VOSS username corresponding to the the Username in Cisco Unified Contact Centre Express.",
"title": "Cisco Unified Contact Centre Express User Name"
},
"username_macro_cucm": {
"items": {
"type": "string"
},
"required": false,
"type": "array",
"description": "The macro to resolve the VOSS username corresponding to the the Username in Cisco Unified Communication Manager.",
"title": "Cisco Unified Communication Manager User Name"
},
"username_macro_ms_teams": {
"items": {
"type": "string"
},
"required": false,
"type": "array",
"description": "The macro to resolve the VOSS username corresponding to the the Username in Microsoft Teams.",
"title": "Microsoft Teams User Name"
},
"username_macro_ldap": {
"items": {
"type": "string"
},
"required": false,
"type": "array",
"description": "The macro to resolve the VOSS username corresponding to the the Username in the LDAP Directory.",
"title": "LDAP Directory User Name"
},
"username_macro_avaya_system_manager": {
"items": {
"type": "string"
},
"required": false,
"type": "array",
"description": "The macro to resolve the VOSS username corresponding to the the Username in Avaya System Manager.",
"title": "Avaya System Manager User Name Macro"
},
"rulesetName": {
"required": true,
"type": "string",
"description": "The name of this ruleset",
"title": "Ruleset Name"
},
"username_macro_hcmf": {
"items": {
"type": "string"
},
"required": false,
"type": "array",
"description": "The macro to resolve the VOSS username corresponding to the the Username in Cisco HCMF.",
"title": "HCMF User Name"
},
"username_macro_open_ldap": {
"items": {
"type": "string"
},
"required": false,
"type": "array",
"description": "The macro to resolve the VOSS username corresponding to the the Username in Opoen LDAP.",
"title": "Open LDAP User Name"
},
"username_macro_webex_teams": {
"items": {
"type": "string"
},
"required": false,
"type": "array",
"description": "The macro to resolve the VOSS username corresponding to the the Username in Webex Teams.",
"title": "Webex Teams User Name"
},
"username_macro_ms_ldap": {
"items": {
"type": "string"
},
"required": false,
"type": "array",
"description": "The macro to resolve the VOSS username corresponding to the the Username in Microsoft LDAP.",
"title": "Microsoft LDAP User Name"
},
"username_macro_broadworks": {
"items": {
"type": "string"
},
"required": false,
"type": "array",
"description": "The macro to resolve the VOSS username corresponding to the the Username in Broadworks.",
"title": "Broadworks User Name Macro"
},
"username_macro_microsoft": {
"items": {
"type": "string"
},
"required": false,
"type": "array",
"description": "The macro to resolve the VOSS username corresponding to the the Microsoft Username.",
"title": "Microsoft User Name"
},
"username_macro_ms_365": {
"items": {
"type": "string"
},
"required": false,
"type": "array",
"description": "The macro to resolve the VOSS username corresponding to the the Username in Microsoft Office 365.",
"title": "Microsoft Office 365 User Name"
},
"username_macro_zoom": {
"items": {
"type": "string"
},
"required": false,
"type": "array",
"description": "The macro to resolve the VOSS username corresponding to the the Username in Zoom.",
"title": "Zoom User Name"
}
},
"schema_version": "0.11"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/MultivendorUsernameMappingMacros/add/ |
|
The GUI Add form of data/MultivendorUsernameMappingMacros as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/data/MultivendorUsernameMappingMacros/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/MultivendorUsernameMappingMacros/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/MultivendorUsernameMappingMacros/[pkid1]", "/api/data/MultivendorUsernameMappingMacros/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/MultivendorUsernameMappingMacros/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=data/MultivendorUsernameMappingMacros |
|
{"hrefs": ["/api/data/MultivendorUsernameMappingMacros/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=data/MultivendorUsernameMappingMacros |
|
{"hrefs": ["/api/data/MultivendorUsernameMappingMacros/[pkid1]", "/api/data/MultivendorUsernameMappingMacros/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/MultivendorUsernameMappingMacros; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/MultivendorUsernameMappingMacros/export/ |
|
{ "hrefs":["/api/data/MultivendorUsernameMappingMacros/[pkid1]", "/api/data/MultivendorUsernameMappingMacros/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of data/MultivendorUsernameMappingMacros and the JSON format can be used to import instances of data/MultivendorUsernameMappingMacros.
GET http://[host-proxy]/api/data/MultivendorUsernameMappingMacros/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/MultivendorUsernameMappingMacros | POST | /api/data/MultivendorUsernameMappingMacros/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/MultivendorUsernameMappingMacros/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/MultivendorUsernameMappingMacros/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/MultivendorUsernameMappingMacros/ |
|
The data/MultivendorUsernameMappingMacros schema and all instances as JSON. |
(The list will return 0 to 3 data/MultivendorUsernameMappingMacros instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"move",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "rulesetName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/MultivendorUsernameMappingMacros/?skip=0&limit=3&order_by=rulesetName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 1
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {
"hierarchy": true,
"unique": [
"rulesetName"
]
},
"schema_version": "0.11",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/data/MultivendorUsernameMappingMacros/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/MultivendorUsernameMappingMacros/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=data/MultivendorUsernameMappingMacros",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/MultivendorUsernameMappingMacros/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/data/MultivendorUsernameMappingMacros/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/data/MultivendorUsernameMappingMacros/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/data/MultivendorUsernameMappingMacros/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/MultivendorUsernameMappingMacros/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/MultivendorUsernameMappingMacros/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"bulk_update": {
"support_async": true,
"class": "update",
"href": "/api/data/MultivendorUsernameMappingMacros/bulk_update/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Bulk Modify"
}
}
],
"model_type": "data/MultivendorUsernameMappingMacros",
"model_specific_actions": [
"get",
"list",
"add",
"update",
"remove",
"help",
"export_bulkload_template",
"bulk_update",
"configuration_template",
"field_display_policy",
"export",
"clone",
"move"
],
"summary_attrs": [
{
"name": "rulesetName",
"title": "Ruleset Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "6305155c43fcc416f18fa0f8",
"meta": {
"tags": [
"V4UC",
"ba_CommonOverlay"
],
"cached": true,
"title": "system",
"business_key": {
"hierarchy": true,
"unique": [
"rulesetName"
]
},
"schema_version": "0.11",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6305155c43fcc416f18fa0f8",
"href": "/api/data/MultivendorUsernameMappingMacros/6305155c43fcc416f18fa0f8/"
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/MultivendorUsernameMappingMacros/6305155c43fcc416f18fa0f8/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/MultivendorUsernameMappingMacros/6305155c43fcc416f18fa0f8/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/MultivendorUsernameMappingMacros/6305155c43fcc416f18fa0f8/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/6305155c43fcc416f18fa0f8/?model_type=data/MultivendorUsernameMappingMacros",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/MultivendorUsernameMappingMacros/6305155c43fcc416f18fa0f8/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/MultivendorUsernameMappingMacros/6305155c43fcc416f18fa0f8/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/MultivendorUsernameMappingMacros/6305155c43fcc416f18fa0f8/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/MultivendorUsernameMappingMacros",
"path": [
"6t0ggef2c0deab00hb595101",
"6305155c43fcc416f18fa0f8"
],
"summary_attrs": [
{
"name": "rulesetName",
"title": "Ruleset Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"username_macro_cucm": [
"{{ input.userid }}",
"{{ input.userIdentity }}"
],
"username_macro_ms_teams": [
"{{ input.UserPrincipalName }}",
"{{ fn.one macro.GetO365UserPart }}"
],
"username_macro_ldap": [
"{{ input.sAMAccountName }}",
"{{ input.userPrincipalName }}"
],
"rulesetName": "system",
"pkid": "6305155c43fcc416f18fa0f9",
"hierarchy_friendly_name": "sys (System)",
"username_macro_ms_365": [
"{{ input.UserPrincipalName }}",
"{{ fn.one macro.GetO365UserPart }}"
],
"hierarchy_path": "sys"
}
}
]
}
(Show the first instance)
{
"pkid": "6305155c43fcc416f18fa0f8",
"meta": {
"tags": [
"V4UC",
"ba_CommonOverlay"
],
"cached": false,
"title": "system",
"business_key": {
"hierarchy": true,
"unique": [
"rulesetName"
]
},
"schema_version": "0.11",
"references": {
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"self": [
{
"pkid": "6305155c43fcc416f18fa0f8",
"href": "/api/data/MultivendorUsernameMappingMacros/6305155c43fcc416f18fa0f8/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/MultivendorUsernameMappingMacros/6305155c43fcc416f18fa0f8/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/MultivendorUsernameMappingMacros/6305155c43fcc416f18fa0f8/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/MultivendorUsernameMappingMacros/6305155c43fcc416f18fa0f8/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/6305155c43fcc416f18fa0f8/?hierarchy=[hierarchy]&model_type=data/MultivendorUsernameMappingMacros",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/MultivendorUsernameMappingMacros/6305155c43fcc416f18fa0f8/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/MultivendorUsernameMappingMacros/6305155c43fcc416f18fa0f8/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/MultivendorUsernameMappingMacros/6305155c43fcc416f18fa0f8/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/MultivendorUsernameMappingMacros",
"path": [
"6t0ggef2c0deab00hb595101",
"6305155c43fcc416f18fa0f8"
],
"summary_attrs": [
{
"name": "rulesetName",
"title": "Ruleset Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"username_macro_cucm": [
"{{ input.userid }}",
"{{ input.userIdentity }}"
],
"username_macro_ms_teams": [
"{{ input.UserPrincipalName }}",
"{{ fn.one macro.GetO365UserPart }}"
],
"username_macro_ldap": [
"{{ input.sAMAccountName }}",
"{{ input.userPrincipalName }}"
],
"rulesetName": "system",
"pkid": "6305155c43fcc416f18fa0f9",
"username_macro_ms_365": [
"{{ input.UserPrincipalName }}",
"{{ fn.one macro.GetO365UserPart }}"
]
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/MultivendorUsernameMappingMacros. | GET | /api/data/MultivendorUsernameMappingMacros/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/MultivendorUsernameMappingMacros as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/MultivendorUsernameMappingMacros/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/MultivendorUsernameMappingMacros/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/MultivendorUsernameMappingMacros/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/MultivendorUsernameMappingMacros/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=data/MultivendorUsernameMappingMacros | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/MultivendorUsernameMappingMacros; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/MultivendorUsernameMappingMacros/[pkid]/export/ |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of data/MultivendorUsernameMappingMacros and the JSON format can be used to import instances of data/MultivendorUsernameMappingMacros.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/MultivendorUsernameMappingMacros/[pkid]/ | hierarchy=[hierarchy] | The data/MultivendorUsernameMappingMacros instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/MultivendorUsernameMappingMacros/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/MultivendorUsernameMappingMacros. |