[Index]
This model stores information about a Microsoft Tenant Connection
Model ref.: data/MicrosoftOperatorConnectTenant
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": { "name": { "description": "Microsoft Operator Connect user defined name can have a max length of 255 charactors within the following regex pattern - ^[a-zA-Z0-9-_ ]+$", "title": "Name", "pattern": "^[a-zA-Z0-9-_. ]+$", "required": true, "maxLength": 255, "type": "string" }, "description": { "maxLength": 255, "type": "string", "description": "Microsoft Operator Connect defined description can have a max length of 255 charactors.", "title": "Description" }, "auth_method": { "description": "Type of authentication to use when interfacing to the external service.", "title": "Authentication Method", "required": false, "choices": [ { "value": "BASIC", "title": "HTTP Basic Authentication" }, { "value": "OAUTH", "title": "OAuth(OApen Authorization)" }, { "value": "SESSION", "title": "Session Based Authentication" } ], "type": "string" }, "syncMsOperatorConnect": { "default": false, "type": "boolean", "description": "Sync Microsoft Operator Connect on Create and Update. When this checkbox is checked it will execute a full Pull Sync from the Microsoft Operator Connect.", "title": "Microsoft Operator Connect sync on Create/Update" }, "client_id": { "is_password": false, "description": "The Client ID or Application ID located in the Azure AD app registration portal.", "title": "Client ID", "required": true, "displayable": false, "readonly": false, "type": "string" }, "tenant_id": { "is_password": false, "description": "The Tenant ID or Directory ID located in the Azure AD app registration portal.", "title": "Tenant ID", "required": true, "displayable": false, "readonly": false, "type": "string" }, "client_secret": { "is_password": true, "description": "A Client secret previously created in the Azure AD app registration portal.", "title": "Secret", "required": false, "readonly": false, "store_encrypted": true, "type": "string" }, "resource": { "description": "Tenant resource", "title": "Tenant resource", "default": "", "store_encrypted": true, "type": "string" }, "version": { "description": "Version", "title": "Version", "default": "v1.0", "required": true, "type": "string" }, "http_proxy": { "store_encrypted": true, "type": "string", "description": "MS proxy", "title": "Microsoft proxy" }, "https_proxy": { "store_encrypted": true, "type": "string", "description": "MS secure proxy", "title": "Microsoft secure proxy" } }, "schema_version": "0.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/MicrosoftOperatorConnectTenant/add/ |
|
The GUI Add form of data/MicrosoftOperatorConnectTenant 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/MicrosoftOperatorConnectTenant | 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/MicrosoftOperatorConnectTenant/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/MicrosoftOperatorConnectTenant/[pkid1]", "/api/data/MicrosoftOperatorConnectTenant/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/MicrosoftOperatorConnectTenant/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/MicrosoftOperatorConnectTenant; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/MicrosoftOperatorConnectTenant/export/ |
|
{ "hrefs":["/api/data/MicrosoftOperatorConnectTenant/[pkid1]", "/api/data/MicrosoftOperatorConnectTenant/[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/MicrosoftOperatorConnectTenant and the JSON format can be used to import instances of data/MicrosoftOperatorConnectTenant.
GET http://[host-proxy]/api/data/MicrosoftOperatorConnectTenant/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/MicrosoftOperatorConnectTenant | POST | /api/data/MicrosoftOperatorConnectTenant/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Tag | PATCH | /api/data/MicrosoftOperatorConnectTenant/+tag/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/data/MicrosoftOperatorConnectTenant/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/data/MicrosoftOperatorConnectTenant/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/MicrosoftOperatorConnectTenant/ |
|
The data/MicrosoftOperatorConnectTenant schema and all instances as JSON. |
(The list will return 0 to 3 data/MicrosoftOperatorConnectTenant instances)
{ "pagination": { "skip": 0, "limit": 3, "maximum_limit": 2000, "total": 0, "total_limit": null, "order_by": "name", "direction": "asc", "current": "/api/data/MicrosoftOperatorConnectTenant/?skip=0&limit=3&order_by=name&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/MicrosoftOperatorConnectTenant", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "", "business_key": {}, "api_version": "21.2", "cached": true, "references": { "children": [], "parent": [ { "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101", "pkid": "6t0ggef2c0deab00hb595101" } ], "device": [ { "href": "", "pkid": "" } ], "foreign_key": [] }, "model_specific_actions": [ "add", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "get", "help", "list", "remove", "tag", "update" ], "schema_version": "0.0", "actions": [ { "add": { "method": "GET", "class": "add", "href": "/api/data/MicrosoftOperatorConnectTenant/add/?hierarchy=[hierarchy]", "support_async": false, "title": "Add" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/MicrosoftOperatorConnectTenant/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "export": { "method": "POST", "class": "export", "href": "/api/data/MicrosoftOperatorConnectTenant/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/MicrosoftOperatorConnectTenant/export_bulkload_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Export Bulk Load Template" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/MicrosoftOperatorConnectTenant/+tag/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "method": "GET", "class": "config", "href": "/api/data/MicrosoftOperatorConnectTenant/configuration_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Configuration Template" } }, { "field_display_policy": { "method": "GET", "class": "display_policy", "href": "/api/data/MicrosoftOperatorConnectTenant/field_display_policy/?hierarchy=[hierarchy]", "support_async": false, "title": "Field Display Policy" } }, { "list": { "method": "GET", "class": "list", "href": "/api/data/MicrosoftOperatorConnectTenant/?hierarchy=[hierarchy]", "support_async": false, "title": "List" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/MicrosoftOperatorConnectTenant/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } } ] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/MicrosoftOperatorConnectTenant. | GET | /api/data/MicrosoftOperatorConnectTenant/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/MicrosoftOperatorConnectTenant as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/MicrosoftOperatorConnectTenant/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/MicrosoftOperatorConnectTenant/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of data/MicrosoftOperatorConnectTenant; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/MicrosoftOperatorConnectTenant/[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/MicrosoftOperatorConnectTenant and the JSON format can be used to import instances of data/MicrosoftOperatorConnectTenant.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/data/MicrosoftOperatorConnectTenant/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/MicrosoftOperatorConnectTenant/[pkid] | hierarchy=[hierarchy] | The data/MicrosoftOperatorConnectTenant instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/MicrosoftOperatorConnectTenant/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/MicrosoftOperatorConnectTenant. |