[Index]
Model ref.: device/exchange/UMMailboxPIN
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": { "FirstTimeUser": { "__type_requested": "System.Boolean", "required": true, "name": "FirstTimeUser", "title": "FirstTimeUser", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "PinExpired": { "__type_requested": "System.Boolean", "required": true, "name": "PinExpired", "title": "PinExpired", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The PINExpired parameter specifies whether the PIN is treated as expired. If this parameter is supplied and is set to $false, the user isn't required to reset the PIN the next time that the user logs on. If the PIN isn't supplied, the PIN is treated as expired and the user is prompted to reset the PIN the next time that the user logs on." }, "IsValid": { "__type_requested": "System.Boolean", "required": true, "name": "IsValid", "title": "IsValid", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "PSComputerName": { "__type_requested": "System.String", "required": false, "name": "PSComputerName", "title": "PSComputerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "UserID": { "__type_requested": "System.String", "required": true, "name": "UserID", "title": "UserID", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "ObjectState": { "__type_requested": "System.String", "required": true, "name": "ObjectState", "title": "ObjectState", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "LockedOut": { "__type_requested": "System.Boolean", "required": true, "name": "LockedOut", "title": "LockedOut", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The LockedOut parameter specifies whether the mailbox will continue to be locked. If set to $true, the mailbox is marked as locked out. By default, if this parameter is omitted or set to $false, the command clears the locked-out status on the mailbox." }, "RunspaceId": { "__type_requested": "System.Guid", "required": false, "name": "RunspaceId", "title": "RunspaceId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "PSShowComputerName": { "__type_requested": "System.Boolean", "required": false, "name": "PSShowComputerName", "title": "PSShowComputerName", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "Identity": { "__type_requested": "System.String", "required": true, "name": "Identity", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The Identity parameter specifies the identifier that can be used to retrieve information about the mailbox. The values for this parameter include the following:\nADObjectID\nGUID\nDistinguished name (DN)\nDomain\\Account\nUser principal name (UPN)\nLegacyExchangeDN\nSmtpAddress\nAlias" } }, "schema_version": "15312" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchange/UMMailboxPIN/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchange/UMMailboxPIN/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchange/UMMailboxPIN/[pkid1]", "/api/v0/device/exchange/UMMailboxPIN/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchange/UMMailboxPIN/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchange/UMMailboxPIN |
|
{"hrefs": ["/api/device/exchange/UMMailboxPIN/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchange/UMMailboxPIN |
|
{"hrefs": ["/api/device/exchange/UMMailboxPIN/[pkid1]", "/api/device/exchange/UMMailboxPIN/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchange/UMMailboxPIN; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchange/UMMailboxPIN/export/ |
|
{ "hrefs":["/api/device/exchange/UMMailboxPIN/[pkid1]", "/api/device/exchange/UMMailboxPIN/[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 device/exchange/UMMailboxPIN and the JSON format can be used to import instances of device/exchange/UMMailboxPIN.
GET http://[host-proxy]/api/device/exchange/UMMailboxPIN/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchange/UMMailboxPIN | POST | /api/device/exchange/UMMailboxPIN/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/device/exchange/UMMailboxPIN/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/exchange/UMMailboxPIN/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchange/UMMailboxPIN/ |
|
The device/exchange/UMMailboxPIN schema and all instances as JSON. |
(The list will return 0 to 3 device/exchange/UMMailboxPIN instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": null, "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchange/UMMailboxPIN/?skip=0&limit=3&order_by=None&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "15312", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/exchange/UMMailboxPIN/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Bulk Modify" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/exchange/UMMailboxPIN", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchange/UMMailboxPIN/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/device/exchange/UMMailboxPIN/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchange/UMMailboxPIN/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchange/UMMailboxPIN/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchange/UMMailboxPIN/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchange/UMMailboxPIN/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchange/UMMailboxPIN/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchange/UMMailboxPIN", "model_specific_actions": [ "get", "list", "update", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/exchange/UMMailboxPIN. | GET | /api/device/exchange/UMMailboxPIN/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchange/UMMailboxPIN as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/exchange/UMMailboxPIN/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchange/UMMailboxPIN/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchange/UMMailboxPIN/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchange/UMMailboxPIN | 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 device/exchange/UMMailboxPIN; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchange/UMMailboxPIN/[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 device/exchange/UMMailboxPIN and the JSON format can be used to import instances of device/exchange/UMMailboxPIN.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchange/UMMailboxPIN/[pkid]/ | hierarchy=[hierarchy] | The device/exchange/UMMailboxPIN instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchange/UMMailboxPIN/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchange/UMMailboxPIN. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchange/UMMailboxPIN/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |