[Index]
The User field mappings from various applications.
Model ref.: data/UserFieldMapping
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": { "customString3": { "type": "string", "description": "Custom String", "title": "Custom String 3" }, "customListOfStrings10": { "type": "string", "description": "Custom List of Strings", "title": "Custom List of Strings 10" }, "last_name": { "type": "string", "description": "The last name corresponding to user last name in Cisco Unified Communications Manager and Cisco Unity Connection server.", "title": "Last Name" }, "customString7": { "type": "string", "description": "Custom String", "title": "Custom String 7" }, "data_exist": { "type": "boolean", "description": "Flag to see if data exists for the server. If data exist the username and email fields will be disabled. These mappings cannot be changed once data exists.", "title": "Data Exist" }, "manager": { "type": "string", "description": "Manager.", "title": "Manager" }, "street": { "type": "string", "description": "Contains site information from a postal address.", "title": "Street" }, "postal_code": { "type": "string", "description": "Contains code used by a Postal Service to identify postal service zones.", "title": "Postal Code" }, "other_mailbox": { "type": "string", "description": "Other Mailbox.", "title": "Other Mailbox" }, "timezone": { "type": "string", "description": "Timezone.", "title": "Timezone" }, "customBoolean1": { "type": "string", "description": "Custom Boolean", "title": "Custom Boolean 1" }, "object_class": { "type": "string", "description": "Object Class.", "title": "Object Class" }, "customListOfStrings2": { "type": "string", "description": "Custom List of Strings", "title": "Custom List of Strings 2" }, "building_name": { "type": "string", "description": "Building name or number.", "title": "Building Name" }, "city": { "type": "string", "description": "Contains the name of a person's locality.", "title": "City" }, "first_name": { "type": "string", "description": "The first name corresponding to the user first name in Cisco Unified Communications Manager and Cisco Unity Connection server.", "title": "First Name" }, "jabber_id": { "type": "string", "description": "Jabber ID", "title": "Jabber ID" }, "display_name": { "type": "string", "description": "Display name of the user", "title": "Display Name" }, "customListOfStrings3": { "type": "string", "description": "Custom List of Strings", "title": "Custom List of Strings 3" }, "directory_uri": { "type": "string", "description": "Alphanumeric Directory URI (e.g. SIP URI)", "title": "Directory URI" }, "customBoolean10": { "type": "string", "description": "Custom Boolean", "title": "Custom Boolean 10" }, "customBoolean2": { "type": "string", "description": "Custom Boolean", "title": "Custom Boolean 2" }, "facsimile_telephone_number": { "type": "string", "description": "Facsimile Telephone Number", "title": "Facsimile Telephone Number" }, "customListOfStrings5": { "type": "string", "description": "Custom List of Strings", "title": "Custom List of Strings 5" }, "application": { "description": "Application name like CUCM, LDAP, CUC", "format": "uri", "title": "Application name", "required": true, "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] }, "state": { "type": "string", "description": "Contains full names of state or province.", "title": "State" }, "customListOfStrings6": { "type": "string", "description": "Custom List of Strings", "title": "Custom List of Strings 6" }, "home_phone": { "type": "string", "description": "Contains strings that represent the user's home phone number(s).", "title": "Home Phone" }, "department": { "type": "string", "description": "Department names and numbers.", "title": "Department" }, "customListOfStrings7": { "type": "string", "description": "Custom List of Strings", "title": "Custom List of Strings 7" }, "email": { "required": false, "type": "string", "description": "The email address corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.", "title": "Email Address" }, "username": { "type": "string", "description": "The username corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.", "title": "User Name" }, "customString2": { "type": "string", "description": "Custom String", "title": "Custom String 2" }, "customString1": { "type": "string", "description": "Custom String", "title": "Custom String 1" }, "physical_delivery_office_name": { "type": "string", "description": "Physical Delivery Office Name.", "title": "Physical Delivery Office Name" }, "description": { "type": "string", "description": "The description of the user mapping object.", "title": "Description" }, "customString5": { "type": "string", "description": "Custom String", "title": "Custom String 5" }, "customString4": { "type": "string", "description": "Custom String", "title": "Custom String 4" }, "title": { "type": "string", "description": "Title.", "title": "Title" }, "customString9": { "type": "string", "description": "Custom String", "title": "Custom String 9" }, "customString8": { "type": "string", "description": "Custom String", "title": "Custom String 8" }, "customListOfStrings8": { "type": "string", "description": "Custom List of Strings", "title": "Custom List of Strings 8" }, "customListOfStrings9": { "type": "string", "description": "Custom List of Strings", "title": "Custom List of Strings 9" }, "customListOfStrings1": { "type": "string", "description": "Custom List of Strings", "title": "Custom List of Strings 1" }, "employee_type": { "type": "string", "description": "Employee type", "title": "Employee Type" }, "password": { "type": "string", "description": "The password corresponding to the user password in Cisco Unified Communications Manager. The password is hidden.", "title": "Password" }, "customListOfStrings4": { "type": "string", "description": "Custom List of Strings", "title": "Custom List of Strings 4" }, "unverified_mailbox": { "type": "string", "description": "Unverified Mail Box.", "title": "Unverified Mail Box" }, "customString6": { "type": "string", "description": "Custom String", "title": "Custom String 6" }, "photo_url": { "type": "string", "description": "Photo URL.", "title": "Photo URL" }, "customBoolean7": { "type": "string", "description": "Custom Boolean", "title": "Custom Boolean 7" }, "customBoolean6": { "type": "string", "description": "Custom Boolean", "title": "Custom Boolean 6" }, "customBoolean5": { "type": "string", "description": "Custom Boolean", "title": "Custom Boolean 5" }, "customBoolean4": { "type": "string", "description": "Custom Boolean", "title": "Custom Boolean 4" }, "customBoolean3": { "type": "string", "description": "Custom Boolean", "title": "Custom Boolean 3" }, "name": { "required": true, "type": "string", "description": "The name of the user mapping object.", "title": "Name" }, "preferred_language": { "type": "string", "description": "Preferred Language.", "title": "Preferred Language" }, "member_of": { "type": "string", "description": "The user can be a member of a variety of groups.", "title": "Member Of" }, "mobile": { "type": "string", "description": "Contains strings that represent the user's IP mobile number(s).", "title": "Mobile" }, "country": { "type": "string", "description": "Country name.", "title": "Country" }, "employee_number": { "type": "string", "description": "Employee number of the user", "title": "Employee Number" }, "telephone_number": { "type": "string", "description": "Telephone Number.", "title": "Telephone Number" }, "customBoolean9": { "type": "string", "description": "Custom Boolean", "title": "Custom Boolean 9" }, "customBoolean8": { "type": "string", "description": "Custom Boolean", "title": "Custom Boolean 8" }, "customString10": { "type": "string", "description": "Custom String", "title": "Custom String 10" }, "ip_phone": { "type": "string", "description": "Contains strings that represent the user's IP phone number(s).", "title": "IP Phone" }, "model_type": { "type": "string", "description": "The model type used for this LDAP server.", "title": "Model Type" }, "organization": { "type": "string", "description": "The name of the person's organization.", "title": "Organization" }, "ou": { "type": "string", "description": "The name of the person's organization unit.", "title": "Organizational Unit" } }, "schema_version": "0.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/UserFieldMapping/add/ |
|
The GUI Add form of data/UserFieldMapping 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/UserFieldMapping/ | 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/UserFieldMapping/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/UserFieldMapping/[pkid1]", "/api/data/UserFieldMapping/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/UserFieldMapping/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/data/UserFieldMapping/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/data/UserFieldMapping/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/UserFieldMapping/[pkid1]", "/api/v0/data/UserFieldMapping/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/UserFieldMapping/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/UserFieldMapping; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/UserFieldMapping/export/ |
|
{ "hrefs":["/api/data/UserFieldMapping/[pkid1]", "/api/data/UserFieldMapping/[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/UserFieldMapping and the JSON format can be used to import instances of data/UserFieldMapping.
GET http://[host-proxy]/api/data/UserFieldMapping/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/UserFieldMapping | POST | /api/data/UserFieldMapping/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/UserFieldMapping/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/data/UserFieldMapping/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Migration Template | GET | /api/data/UserFieldMapping/migration/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/UserFieldMapping/ |
|
The data/UserFieldMapping schema and all instances as JSON. |
(The list will return 0 to 3 data/UserFieldMapping instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "list", "update", "remove", "transform", "add", "export", "migration", "bulk_update_form" ], "pagination": { "direction": "asc", "order_by": "name", "maximum_limit": 2000, "skip": 0, "current": "/api/data/UserFieldMapping/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 20 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": { "hierarchy": true, "unique": [ "name", "application" ] }, "schema_version": "0.0", "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/UserFieldMapping/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/UserFieldMapping/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/data/UserFieldMapping/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Bulk Modify" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/UserFieldMapping/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/UserFieldMapping/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/UserFieldMapping/+tag/?hierarchy=[hierarchy]", "class": "tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "title": "Tag Version", "support_async": true, "method": "PATCH", "href": "/api/data/UserFieldMapping/+tag_version/?hierarchy=[hierarchy]", "class": "tag_version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/data/UserFieldMapping/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/data/UserFieldMapping/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "migration": { "support_async": false, "class": "migration", "href": "/api/data/UserFieldMapping/migration/?hierarchy=[hierarchy]", "method": "GET", "title": "Migration Template" } }, { "list": { "support_async": false, "class": "list", "href": "/api/data/UserFieldMapping/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/UserFieldMapping/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/UserFieldMapping", "model_specific_actions": [ "get", "list", "add", "clone", "update", "remove", "export_bulkload_template", "bulk_update_form", "configuration_template", "field_display_policy", "export", "migration", "help", "tag", "tag_version" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "application", "title": "Application name" }, { "name": "description", "title": "Description" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [ { "pkid": "61b1a9cbeadb826afd8853a4", "meta": { "tags": [], "cached": true, "title": "[\"10.120.2.221\", \"389\", \"OU=RAS,OU=AAAGlobal,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"] - LDAP", "business_key": { "hierarchy": true, "unique": [ "name", "application" ] }, "schema_version": "0.0", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "61b1a9cbeadb826afd8853a4", "href": "/api/data/UserFieldMapping/61b1a9cbeadb826afd8853a4/" } ], "parent": [ { "pkid": "61b12edfeadb826afd7b715a", "href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a" } ], "foreign_key": [ { "pkid": "61b0eafb41e9336d6e1fd157", "path": "application", "model_type": "data/UserSyncSource" } ] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/UserFieldMapping/61b1a9cbeadb826afd8853a4/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/UserFieldMapping/61b1a9cbeadb826afd8853a4/", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/data/UserFieldMapping/61b1a9cbeadb826afd8853a4/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/UserFieldMapping/61b1a9cbeadb826afd8853a4/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/UserFieldMapping/61b1a9cbeadb826afd8853a4/+tag/", "class": "tag", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "title": "Tag Version", "support_async": true, "method": "PATCH", "href": "/api/data/UserFieldMapping/61b1a9cbeadb826afd8853a4/+tag_version/", "class": "tag_version", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/UserFieldMapping/61b1a9cbeadb826afd8853a4/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/UserFieldMapping/61b1a9cbeadb826afd8853a4/help", "method": "GET", "title": "Help" } } ], "model_type": "data/UserFieldMapping", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b12ed1eadb826afd7b6ddc", "61b12edfeadb826afd7b715a", "61b1a9cbeadb826afd8853a4" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "application", "title": "Application name" }, { "name": "description", "title": "Description" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "last_name": "sn", "manager": "manager", "street": "streetAddress", "postal_code": "postalCode", "facsimile_telephone_number": "facsimileTelephoneNumber", "hierarchy_friendly_name": "AAAGlobal (Customer)", "object_class": "objectClass", "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal", "city": "l", "first_name": "givenName", "display_name": "displayName", "employee_number": "employeeNumber", "pkid": "61b1a9cbeadb826afd8853a8", "other_mailbox": "otherMailbox", "application": "LDAP", "state": "st", "home_phone": "homePhone", "department": "department", "email": "mail", "username": "sAMAccountName", "physical_delivery_office_name": "physicalDeliveryOfficeName", "description": "LDAP field mapping for [\"10.120.2.221\", \"389\", \"OU=RAS,OU=AAAGlobal,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"]", "employee_type": "employeeType", "name": "[\"10.120.2.221\", \"389\", \"OU=RAS,OU=AAAGlobal,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"]", "member_of": "memberOf", "mobile": "mobile", "country": "c", "title": "title", "telephone_number": "telephoneNumber", "ip_phone": "ipPhone", "model_type": "device/ldap/user", "organization": "o", "ou": "ou" } }, { "pkid": "61b1a6bceadb826afd87c959", "meta": { "tags": [], "cached": true, "title": "[\"10.120.2.221\", \"389\", \"OU=RAV,OU=AAAGlobal,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"] - LDAP", "business_key": { "hierarchy": true, "unique": [ "name", "application" ] }, "schema_version": "0.0", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "61b1a6bceadb826afd87c959", "href": "/api/data/UserFieldMapping/61b1a6bceadb826afd87c959/" } ], "parent": [ { "pkid": "61b12edfeadb826afd7b715a", "href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a" } ], "foreign_key": [ { "pkid": "61b0eafb41e9336d6e1fd157", "path": "application", "model_type": "data/UserSyncSource" } ] }, "actions": [ { "update": { "support_async": true, "href": "/api/data/UserFieldMapping/61b1a6bceadb826afd87c959/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/data/UserFieldMapping/61b1a6bceadb826afd87c959/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "clone": { "support_async": false, "href": "/api/data/UserFieldMapping/61b1a6bceadb826afd87c959/clone/?schema=&schema_rules=true", "title": "Clone", "class": "clone", "method": "GET" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/UserFieldMapping/61b1a6bceadb826afd87c959/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "class": "tag", "href": "/api/data/UserFieldMapping/61b1a6bceadb826afd87c959/+tag/", "method": "PATCH", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "title": "Tag Version", "support_async": true, "class": "tag_version", "href": "/api/data/UserFieldMapping/61b1a6bceadb826afd87c959/+tag_version/", "method": "PATCH", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "support_async": false, "href": "/api/data/UserFieldMapping/61b1a6bceadb826afd87c959/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/data/UserFieldMapping/61b1a6bceadb826afd87c959/help", "title": "Help", "class": "help", "method": "GET" } } ], "model_type": "data/UserFieldMapping", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b12ed1eadb826afd7b6ddc", "61b12edfeadb826afd7b715a", "61b1a6bceadb826afd87c959" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "application", "title": "Application name" }, { "name": "description", "title": "Description" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "last_name": "sn", "manager": "manager", "street": "streetAddress", "postal_code": "postalCode", "facsimile_telephone_number": "facsimileTelephoneNumber", "hierarchy_friendly_name": "AAAGlobal (Customer)", "object_class": "objectClass", "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal", "city": "l", "first_name": "givenName", "display_name": "displayName", "employee_number": "employeeNumber", "pkid": "61b1a6bceadb826afd87c95d", "other_mailbox": "otherMailbox", "application": "LDAP", "state": "st", "home_phone": "homePhone", "department": "department", "email": "mail", "username": "sAMAccountName", "physical_delivery_office_name": "physicalDeliveryOfficeName", "description": "LDAP field mapping for [\"10.120.2.221\", \"389\", \"OU=RAV,OU=AAAGlobal,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"]", "employee_type": "employeeType", "name": "[\"10.120.2.221\", \"389\", \"OU=RAV,OU=AAAGlobal,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"]", "member_of": "memberOf", "mobile": "mobile", "country": "c", "title": "title", "telephone_number": "telephoneNumber", "ip_phone": "ipPhone", "model_type": "device/ldap/user", "organization": "o", "ou": "ou" } }, { "pkid": "61b1b2cbeadb826afd89f838", "meta": { "tags": [], "cached": true, "title": "[\"10.120.2.221\", \"389\", \"OU=TM,OU=AAAGlobal,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"] - LDAP", "business_key": { "hierarchy": true, "unique": [ "name", "application" ] }, "schema_version": "0.0", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "61b1b2cbeadb826afd89f838", "href": "/api/data/UserFieldMapping/61b1b2cbeadb826afd89f838/" } ], "parent": [ { "pkid": "61b12edfeadb826afd7b715a", "href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a" } ], "foreign_key": [ { "pkid": "61b0eafb41e9336d6e1fd157", "path": "application", "model_type": "data/UserSyncSource" } ] }, "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/data/UserFieldMapping/61b1b2cbeadb826afd89f838/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/data/UserFieldMapping/61b1b2cbeadb826afd89f838/", "class": "delete", "title": "Delete" } }, { "clone": { "support_async": false, "method": "GET", "href": "/api/data/UserFieldMapping/61b1b2cbeadb826afd89f838/clone/?schema=&schema_rules=true", "class": "clone", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "method": "GET", "href": "/api/data/UserFieldMapping/61b1b2cbeadb826afd89f838/export/", "class": "export", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "class": "tag", "href": "/api/data/UserFieldMapping/61b1b2cbeadb826afd89f838/+tag/", "method": "PATCH", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "title": "Tag Version", "support_async": true, "class": "tag_version", "href": "/api/data/UserFieldMapping/61b1b2cbeadb826afd89f838/+tag_version/", "method": "PATCH", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/data/UserFieldMapping/61b1b2cbeadb826afd89f838/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/data/UserFieldMapping/61b1b2cbeadb826afd89f838/help", "class": "help", "title": "Help" } } ], "model_type": "data/UserFieldMapping", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b12ed1eadb826afd7b6ddc", "61b12edfeadb826afd7b715a", "61b1b2cbeadb826afd89f838" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "application", "title": "Application name" }, { "name": "description", "title": "Description" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "last_name": "sn", "manager": "manager", "street": "streetAddress", "postal_code": "postalCode", "facsimile_telephone_number": "facsimileTelephoneNumber", "hierarchy_friendly_name": "AAAGlobal (Customer)", "object_class": "objectClass", "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal", "city": "l", "first_name": "givenName", "display_name": "displayName", "employee_number": "employeeNumber", "pkid": "61b1b2cbeadb826afd89f83c", "other_mailbox": "otherMailbox", "application": "LDAP", "state": "st", "home_phone": "homePhone", "department": "department", "email": "mail", "username": "sAMAccountName", "physical_delivery_office_name": "physicalDeliveryOfficeName", "description": "LDAP field mapping for [\"10.120.2.221\", \"389\", \"OU=TM,OU=AAAGlobal,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"]", "employee_type": "employeeType", "name": "[\"10.120.2.221\", \"389\", \"OU=TM,OU=AAAGlobal,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"]", "member_of": "memberOf", "mobile": "mobile", "country": "c", "title": "title", "telephone_number": "telephoneNumber", "ip_phone": "ipPhone", "model_type": "device/ldap/user", "organization": "o", "ou": "ou" } } ] }
(Show the first instance)
{ "pkid": "61b1a9cbeadb826afd8853a4", "meta": { "tags": [], "cached": false, "title": "[\"10.120.2.221\", \"389\", \"OU=RAS,OU=AAAGlobal,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"] - LDAP", "business_key": { "hierarchy": true, "unique": [ "name", "application" ] }, "schema_version": "0.0", "references": { "parent": [ { "pkid": "61b12edfeadb826afd7b715a", "href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a" } ], "self": [ { "pkid": "61b1a9cbeadb826afd8853a4", "href": "/api/data/UserFieldMapping/61b1a9cbeadb826afd8853a4/" } ], "foreign_key": [ { "pkid": "61b0eafb41e9336d6e1fd157", "path": "application", "model_type": "data/UserSyncSource" } ], "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/UserFieldMapping/61b1a9cbeadb826afd8853a4/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/UserFieldMapping/61b1a9cbeadb826afd8853a4/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/data/UserFieldMapping/61b1a9cbeadb826afd8853a4/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/UserFieldMapping/61b1a9cbeadb826afd8853a4/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/UserFieldMapping/61b1a9cbeadb826afd8853a4/+tag/?hierarchy=[hierarchy]", "class": "tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "title": "Tag Version", "support_async": true, "method": "PATCH", "href": "/api/data/UserFieldMapping/61b1a9cbeadb826afd8853a4/+tag_version/?hierarchy=[hierarchy]", "class": "tag_version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/UserFieldMapping/61b1a9cbeadb826afd8853a4/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/UserFieldMapping/61b1a9cbeadb826afd8853a4/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/UserFieldMapping", "path": [ "6t0ggef2c0deab00hb595101", "61b0e48541e9336d6e1ee12e", "61b12e93eadb826afd7b5dad", "61b12ed1eadb826afd7b6ddc", "61b12edfeadb826afd7b715a", "61b1a9cbeadb826afd8853a4" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "application", "title": "Application name" }, { "name": "description", "title": "Description" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "last_name": "sn", "manager": "manager", "street": "streetAddress", "postal_code": "postalCode", "other_mailbox": "otherMailbox", "object_class": "objectClass", "city": "l", "first_name": "givenName", "display_name": "displayName", "employee_number": "employeeNumber", "pkid": "61b1a9cbeadb826afd8853a8", "facsimile_telephone_number": "facsimileTelephoneNumber", "application": "LDAP", "state": "st", "home_phone": "homePhone", "department": "department", "email": "mail", "username": "sAMAccountName", "physical_delivery_office_name": "physicalDeliveryOfficeName", "description": "LDAP field mapping for [\"10.120.2.221\", \"389\", \"OU=RAS,OU=AAAGlobal,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"]", "employee_type": "employeeType", "name": "[\"10.120.2.221\", \"389\", \"OU=RAS,OU=AAAGlobal,DC=vossqa,DC=net\", \"hcs.CS-P.CS-NB.AAAGlobal\"]", "member_of": "memberOf", "mobile": "mobile", "country": "c", "title": "title", "telephone_number": "telephoneNumber", "ip_phone": "ipPhone", "model_type": "device/ldap/user", "organization": "o", "ou": "ou" } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/UserFieldMapping. | GET | /api/data/UserFieldMapping/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/UserFieldMapping as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/UserFieldMapping/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/UserFieldMapping/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/UserFieldMapping/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/UserFieldMapping/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of data/UserFieldMapping; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/UserFieldMapping/[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/UserFieldMapping and the JSON format can be used to import instances of data/UserFieldMapping.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/data/UserFieldMapping/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/UserFieldMapping/[pkid]/ | hierarchy=[hierarchy] | The data/UserFieldMapping instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/UserFieldMapping/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/UserFieldMapping. |