[Index]
NormalizedUser
Model ref.: data/NormalizedUser
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": { "is_password": false, "description": "Login in username.", "title": "Username", "required": true, "readonly": false, "maxLength": 1024, "type": "string" }, "buildingName": { "is_password": false, "description": "Building name or number.", "title": "Building", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "userType": { "is_password": false, "title": "User Type", "required": false, "displayable": true, "choices": [ { "value": "CUCM Local", "title": "CUCM Local" }, { "value": "VOSS Only", "title": "VOSS Only" }, { "value": "CUCM-LDAP Synced", "title": "CUCM-LDAP Synced" }, { "value": "VOSS-LDAP Synced", "title": "VOSS-LDAP Synced" }, { "value": "Unknown", "title": "Unknown" } ], "readonly": false, "type": "string" }, "c": { "is_password": false, "description": "Country name.", "title": "Country", "required": false, "readonly": false, "maxLength": 1024, "type": "string" }, "departmentNumber": { "is_password": false, "description": "Department names and numbers.", "title": "Department", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "directoryUri": { "type": "string", "description": "Alphanumeric Directory URI (e.g. SIP URI)", "title": "Directory URI" }, "displayName": { "is_password": false, "title": "Display Name", "required": false, "readonly": false, "maxLength": 1024, "type": "string" }, "employeeNumber": { "is_password": false, "title": "Employee Number", "required": false, "readonly": false, "maxLength": 1024, "type": "string" }, "employeeType": { "is_password": false, "title": "Employee Type", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "facsimileTelephoneNumber": { "is_password": false, "title": "Facsimile Telephone Number", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "givenName": { "is_password": false, "description": "Contains strings that are part of the person's name excluding surnames.", "title": "Given Name", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "homePhone": { "items": { "type": "string" }, "type": "array", "description": "Contains strings that represent the user's home phone number(s).", "title": "Home Phone" }, "ipPhone": { "items": { "type": "string" }, "type": "array", "description": "Contains strings that represent the user's IP phone number(s).", "title": "IP Phone" }, "jabberID": { "is_password": false, "title": "Jabber ID", "required": false, "readonly": false, "maxLength": 1024, "type": "string" }, "l": { "is_password": false, "description": "Contains the name of a person's locality.", "title": "City", "required": false, "readonly": false, "maxLength": 1024, "type": "string" }, "mail": { "is_password": false, "title": "Email Address", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "manager": { "is_password": false, "title": "Manager", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "memberOf": { "items": { "type": "string" }, "type": "array", "description": "The user can be a member of a variety of groups.", "title": "Member Of" }, "mobile": { "is_password": false, "title": "Mobile", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "o": { "is_password": false, "description": "The name of the person's organization.", "title": "Organization", "required": false, "readonly": false, "maxLength": 1024, "type": "string" }, "objectClass": { "is_password": false, "title": "Object Class", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "otherMailbox": { "is_password": false, "title": "Other Mailbox", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "ou": { "is_password": false, "description": "The name of the person's organization unit.", "title": "Organizational Unit", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "photoURL": { "is_password": false, "title": "Photo URL", "required": false, "readonly": false, "maxLength": 1024, "type": "string" }, "physicalDeliveryOfficeName": { "is_password": false, "title": "Physical Delivery Office Name", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "postalCode": { "is_password": false, "description": "Contains codes used by a Postal Service to identify postal service zones.", "title": "Postal Code", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "preferredLanguage": { "is_password": false, "title": "Preferred Language", "required": false, "readonly": false, "maxLength": 1024, "type": "string" }, "sn": { "is_password": false, "description": "Contains strings for the family names of a person.", "title": "Surname", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": true, "readonly": false, "type": "array" }, "st": { "is_password": false, "description": "Contains full names of states or provinces.", "title": "State", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "street": { "is_password": false, "description": "Contains site information from a postal address.", "title": "Street", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "telephoneNumber": { "is_password": false, "title": "Telephone Number", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "timezone": { "is_password": false, "title": "Timezone", "required": false, "readonly": false, "maxLength": 1024, "type": "string" }, "title": { "is_password": false, "title": "Title", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "uid": { "is_password": false, "description": "Contains computer login names for the user.", "title": "Userid", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "unverifiedMailBox": { "is_password": false, "title": "Unverified Mail Box", "minItems": 0, "items": { "is_password": false, "type": "string" }, "required": false, "readonly": false, "type": "array" }, "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" }, "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" } }, "schema_version": "1.7" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/NormalizedUser/add/ |
|
The GUI Add form of data/NormalizedUser 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/NormalizedUser | 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/NormalizedUser/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/NormalizedUser/[pkid1]", "/api/data/NormalizedUser/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/NormalizedUser/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/NormalizedUser; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/NormalizedUser/export/ |
|
{ "hrefs":["/api/data/NormalizedUser/[pkid1]", "/api/data/NormalizedUser/[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/NormalizedUser and the JSON format can be used to import instances of data/NormalizedUser.
GET http://[host-proxy]/api/data/NormalizedUser/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/NormalizedUser | POST | /api/data/NormalizedUser/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/NormalizedUser/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/data/NormalizedUser/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Migration Template | GET | /api/data/NormalizedUser/migration/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/NormalizedUser/ |
|
The data/NormalizedUser schema and all instances as JSON. |
(The list will return 0 to 3 data/NormalizedUser instances)
{ "pagination": { "skip": 0, "limit": 3, "maximum_limit": 2000, "total": 0, "total_limit": null, "order_by": "username", "direction": "asc", "current": "/api/data/NormalizedUser/?skip=0&limit=3&order_by=username&direction=asc&traversal=down" }, "operations": [ "field_display_policy", "update", "help", "remove", "move", "add", "export", "list", "configuration_template", "get", "bulk_update_form", "migration", "transform", "export_bulkload_template" ], "meta": { "model_type": "data/NormalizedUser", "summary_attrs": [ { "name": "username", "title": "Username" }, { "name": "givenName", "title": "Given Name" }, { "name": "sn", "title": "Surname" }, { "name": "mail", "title": "Email Address" }, { "name": "userType", "title": "User Type" }, { "name": "departmentNumber", "title": "Department" }, { "name": "street", "title": "Street" }, { "name": "l", "title": "City" }, { "name": "st", "title": "State" }, { "name": "postalCode", "title": "Postal Code" }, { "name": "buildingName", "title": "Building" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "title format", "business_key": { "hierarchy": true, "unique": [ "username" ] }, "api_version": "21.2", "cached": true, "references": { "children": [], "parent": [ { "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101", "pkid": "6t0ggef2c0deab00hb595101" } ], "device": [ { "href": "", "pkid": "" } ], "foreign_key": [] }, "model_specific_actions": [ "list", "get", "add", "update", "remove", "import", "execute", "export_bulkload_template", "bulk_update", "configuration_template", "field_display_policy", "export", "migration", "help" ], "schema_version": "1.7", "actions": [ { "add": { "method": "GET", "class": "add", "href": "/api/data/NormalizedUser/add/?hierarchy=[hierarchy]", "support_async": false, "title": "Add" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/NormalizedUser/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "export": { "method": "POST", "class": "export", "href": "/api/data/NormalizedUser/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/data/NormalizedUser/export_bulkload_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Export Bulk Load Template" } }, { "configuration_template": { "method": "GET", "class": "config", "href": "/api/data/NormalizedUser/configuration_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Configuration Template" } }, { "field_display_policy": { "method": "GET", "class": "display_policy", "href": "/api/data/NormalizedUser/field_display_policy/?hierarchy=[hierarchy]", "support_async": false, "title": "Field Display Policy" } }, { "migration": { "method": "GET", "class": "migration", "href": "/api/data/NormalizedUser/migration/?hierarchy=[hierarchy]", "support_async": false, "title": "Migration Template" } }, { "list": { "method": "GET", "class": "list", "href": "/api/data/NormalizedUser/?hierarchy=[hierarchy]", "support_async": false, "title": "List" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/NormalizedUser/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } }, { "bulk_update": { "method": "POST", "class": "update", "href": "/api/data/NormalizedUser/bulk_update/?hierarchy=[hierarchy]", "support_async": true, "title": "Bulk Modify" } } ] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/NormalizedUser. | GET | /api/data/NormalizedUser/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/NormalizedUser as HTML |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | POST | /api/data/NormalizedUser/bulk_update/ |
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/NormalizedUser/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/NormalizedUser/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Import | POST | /api/data/NormalizedUser/[pkid]/import | 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/NormalizedUser; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/NormalizedUser/[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/NormalizedUser and the JSON format can be used to import instances of data/NormalizedUser.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Execute | POST | /api/data/NormalizedUser/[pkid]/execute | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/NormalizedUser/[pkid] | hierarchy=[hierarchy] | The data/NormalizedUser instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/NormalizedUser/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/NormalizedUser. |