[Index]
Stores the connection parameters of an MS Online instance.
Model ref.: data/msonline
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", "title": "Username" }, "online_username": { "required": false, "type": "string", "title": "Online Username" }, "inet_proxy_auth_required": { "required": true, "type": "boolean", "description": "If true, authentication credentials must be provided for the outbound Internet proxy", "title": "Outbound Internet Proxy Requires Authentication" }, "inet_proxy_username": { "required": false, "type": "string", "description": "Username to provide for outbound Internet proxy authenticaton", "title": "Outbound Internet Proxy Authentication Username" }, "domain_username": { "required": false, "type": "string", "title": "Domain Username" }, "inet_proxy_password": { "is_password": true, "description": "Password to provide for outbound Internet proxy authenticaton", "title": "Outbound Internet Proxy Authentication Password", "required": false, "store_encrypted": true, "type": "string" }, "model_relation_mapping": { "type": "object", "properties": { "mappings": { "items": { "type": "object", "properties": { "model_to": { "default": "string", "type": "string", "title": "Model To" }, "model_from_attribute": { "default": "string", "type": "string", "title": "Model From Attribute" }, "model_from": { "default": "string", "type": "string", "title": "Model From" }, "model_to_display_attribute": { "default": "string", "type": "string", "title": "Model To Display Attribute" }, "model_to_target_attribute": { "default": "string", "type": "string", "title": "Model To Target Attribute" } } }, "type": "array", "title": "Mappings" } }, "title": "Model Relation Mapping" }, "domain_name": { "required": false, "type": "string", "title": "Domain Name" }, "use_inet_proxy": { "required": true, "type": "boolean", "description": "If true, the PowerShell proxy must traverse an outbound Internet proxy to reach Office 365", "title": "Use Outbound Internet Proxy" }, "domain_password": { "required": false, "is_password": true, "type": "string", "store_encrypted": true, "title": "Domain Password" }, "host": { "required": true, "type": "string", "title": "Host Name" }, "version": { "title": "Version", "required": true, "type": "string", "choices": [ { "value": "2019.1", "title": "Schema as of 2019" } ] }, "online_password": { "required": false, "is_password": true, "type": "string", "store_encrypted": true, "title": "Online Password" }, "password": { "required": true, "is_password": true, "type": "string", "store_encrypted": true, "title": "Password" } }, "schema_version": "0.1.10" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/msonline/add/ |
|
The GUI Add form of data/msonline 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/msonline/ | 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/msonline/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/msonline/[pkid1]", "/api/data/msonline/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/msonline/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/data/msonline/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/data/msonline/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/msonline/[pkid1]", "/api/v0/data/msonline/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/msonline/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/msonline | POST | /api/data/msonline/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/msonline/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/data/msonline/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Migration Template | GET | /api/data/msonline/migration/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/msonline/ |
|
The data/msonline schema and all instances as JSON. |
(The list will return 0 to 3 data/msonline 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": "host", "maximum_limit": 2000, "skip": 0, "current": "/api/data/msonline/?skip=0&limit=3&order_by=host&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "?", "business_key": { "hierarchy": true, "unique": [ "host" ] }, "schema_version": "0.1.10", "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/msonline/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/msonline/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/data/msonline/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Bulk Modify" } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/data/msonline/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/data/msonline/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/data/msonline/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "migration": { "support_async": false, "class": "migration", "href": "/api/data/msonline/migration/?hierarchy=[hierarchy]", "method": "GET", "title": "Migration Template" } }, { "list": { "support_async": false, "class": "list", "href": "/api/data/msonline/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/msonline/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/msonline", "model_specific_actions": [ "add", "bulk_update_form", "clone", "configuration_template", "export_bulkload_template", "field_display_policy", "get", "help", "list", "migration", "remove", "test_connect", "update" ], "summary_attrs": [ { "name": "host", "title": "Host Name" }, { "name": "username", "title": "Username" }, { "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 data/msonline. | GET | /api/data/msonline/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/msonline as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/msonline/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/msonline/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/msonline/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/msonline/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Test Connection | POST | /api/data/msonline/[pkid]/test_connect/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/msonline/[pkid]/ | hierarchy=[hierarchy] | The data/msonline instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/msonline/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/msonline. |