[Index]
This model stores information about a Microsoft Tenant Connection
Model ref.: data/MicrosoftTenant
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": {
"http_proxy_password": {
"is_password": true,
"description": "Password for the proxy server through which the powershell host connects to the cloud.",
"title": "Password",
"required": false,
"readonly": false,
"maxLength": 255,
"store_encrypted": true,
"type": "string"
},
"msol_user_api_page_size": {
"type": "string",
"description": "Controls the number of records retrieved at a time from the device/msgraph/MSOLUser related API. Leaving it blank uses a default of 999 for optimal performance. Only modify this value if you encounter sync errors (e.g., 'Template output exceeded memory limit'), where you can specify a smaller value to resolve the issue. Note that reducing the value may affect sync performance, so use the largest value that doesn't cause errors.",
"title": "Max page size for MsolUser"
},
"hostName": {
"maxLength": 255,
"required": true,
"type": "string",
"description": "Windows powershell host, serves as an intermediary between VOSS and Microsoft Teams, can be an IP address or a host name up to 255 charactors.",
"title": "Host"
},
"tenantPassword": {
"is_password": true,
"description": "Admin password of the above account",
"title": "Admin Password",
"required": true,
"readonly": false,
"maxLength": 255,
"store_encrypted": true,
"type": "string"
},
"exchange_certificate_thumbprint": {
"is_password": true,
"description": "Certificate Thumbprint for a certificate which has been previously uploaded in the Azure AD app registration portal.",
"title": "Certificate Thumbprint",
"required": false,
"readonly": false,
"store_encrypted": true,
"type": "string"
},
"use_proxy": {
"default": "false",
"type": "boolean",
"description": "Use Proxy is for when there is an internet proxy set up between the powershell server and the internet. Setting it to true will make the powershell script make use of it properly so that it can get to the MS cloud. There is another setting use_proxy_auth which comes into play only if use_proxy is true which will do additional configuration when the internet proxy requires auth",
"title": "Use HTTP Proxy"
},
"certificate_bkey": {
"description": "A locally stored certificate the public portion of which has been previously uploaded in the Azure AD app registration portal.",
"format": "uri",
"title": "Certificate",
"required": false,
"choices": [],
"target_model_type": "data/Certificate",
"type": "string",
"target": "/api/data/Certificate/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"syncTeams": {
"default": false,
"type": "boolean",
"description": "Sync Microsoft Teams on Create and Update. When this checkbox is checked it will execute a full Pull Sync from the Microsoft Teams",
"title": "Microsoft Teams sync on Create/Update"
},
"proxyPassword": {
"is_password": true,
"description": "Windows powershell host password of the above service account.",
"title": "Password",
"required": true,
"maxLength": 255,
"store_encrypted": true,
"type": "string"
},
"enable_exchange": {
"default": false,
"type": "boolean",
"description": "Enable Microsoft Exchange.",
"title": "Enable Microsoft Exchange"
},
"https_proxy": {
"store_encrypted": true,
"type": "string",
"description": "Sets an outbound internet proxy server when authentication is required. The format should be (https://proxyuser:proxypassword@host:port/), and it allows secure access to the Internet proxy. You can use either a Fully Qualified Domain Name (FQDN) or an IP address for the Internet proxy.",
"title": "MS 365 secure proxy"
},
"version": {
"default": "2019.1",
"required": true,
"type": "string",
"description": "MS Teams Version",
"title": "Version"
},
"syncGraph": {
"default": false,
"type": "boolean",
"description": "Sync Microsoft 365 on Create and Update. When this checkbox is checked it will execute a full Pull Sync from the Microsoft 365.",
"title": "Microsoft 365 sync on Create/Update"
},
"http_proxy": {
"store_encrypted": true,
"type": "string",
"description": "Specifies an outbound internet proxy server for traffic to the public Internet when no authentication is required. The format should be (https://host:port/), and can include either a Fully Qualified Domain Name (FQDN) or an IP address for the Internet proxy.",
"title": "MS 365 proxy"
},
"description": {
"title": "Description",
"type": "string",
"description": "Microsoft Tenant user defined description can have a max length of 255 charactors.",
"maxLength": 255
},
"tenantUsername": {
"description": "Username of an admin account used by VOSS to access Microsoft Teams.",
"title": "Admin Username",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 255,
"type": "string"
},
"graph_api_certificate_thumbprint": {
"readonly": false,
"required": false,
"type": "string",
"description": "Certificate Thumbprint for a certificate which has been previously uploaded in the Azure AD app registration portal.",
"title": "Certificate Thumbprint"
},
"proxyUsername": {
"is_password": false,
"description": "Windows powershell host service account.",
"title": "Username",
"required": true,
"maxLength": 255,
"type": "string"
},
"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"
},
"groups_api_page_size": {
"type": "string",
"description": "Governs the number of records fetched at once from the device/msgraph/Groups and device/msgraph/Teams related APIs. When left empty, it defaults to 999 for efficient performance. Adjust this value only if you encounter synchronization errors, like ('Template output exceeded memory limit.'). You can specify a smaller value to resolve errors, but be aware that reducing the value may impact sync performance, so use the largest suitable page size.",
"title": "Max page size for Groups"
},
"syncExchange": {
"default": false,
"type": "boolean",
"description": "Sync Microsoft Exchange on Create and Update. When this checkbox is checked it will execute a full Pull Sync from the Microsoft Exchange",
"title": "Microsoft Exchange sync on Create/Update"
},
"auth_method": {
"choices": [
{
"value": "BASIC",
"title": "HTTP Basic Authentication"
},
{
"value": "OAUTH",
"title": "OAuth(OApen Authorization)"
},
{
"value": "SESSION",
"title": "Session Based Authentication"
}
],
"required": false,
"type": "string",
"description": "Type of authentication to use when interfacing to the external service.",
"title": "Authentication Method"
},
"name": {
"description": "Microsoft Tenant 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"
},
"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"
},
"use_http_proxy_auth": {
"default": "false",
"type": "boolean",
"description": "The proxy server through which the powershell server connects to the cloud requires credentials.",
"title": "Use HTTP Proxy Authentication"
},
"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"
},
"powershellDeploymentMode": {
"is_password": false,
"description": "Switch between running powershell scripts using a serverless function in the Azure cloud or an om-prem Windows host",
"title": "Powershell Deployment Mode",
"default": "onprem",
"choices": [
{
"value": "cloud",
"title": "Cloud"
},
{
"value": "onprem",
"title": "OnPrem"
}
],
"maxLength": 255,
"type": "string"
},
"http_proxy_username": {
"displayable": false,
"maxLength": 255,
"type": "string",
"description": "Username for the proxy server through which the powershell host connects to the cloud.",
"title": "Username"
}
},
"schema_version": "1.7"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/MicrosoftTenant/add/ |
|
The GUI Add form of data/MicrosoftTenant 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/MicrosoftTenant | 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/MicrosoftTenant/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/MicrosoftTenant/[pkid1]", "/api/data/MicrosoftTenant/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/MicrosoftTenant/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/MicrosoftTenant; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/MicrosoftTenant/export/ |
|
{ "hrefs":["/api/data/MicrosoftTenant/[pkid1]", "/api/data/MicrosoftTenant/[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/MicrosoftTenant and the JSON format can be used to import instances of data/MicrosoftTenant.
GET http://[host-proxy]/api/data/MicrosoftTenant/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/MicrosoftTenant | POST | /api/data/MicrosoftTenant/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/MicrosoftTenant/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/MicrosoftTenant/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/MicrosoftTenant/ |
|
The data/MicrosoftTenant schema and all instances as JSON. |
(The list will return 0 to 3 data/MicrosoftTenant 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": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/MicrosoftTenant/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 1
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "1.7",
"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/MicrosoftTenant/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/MicrosoftTenant/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/MicrosoftTenant/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/MicrosoftTenant/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/MicrosoftTenant/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/data/MicrosoftTenant/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/data/MicrosoftTenant/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/MicrosoftTenant/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/MicrosoftTenant/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/MicrosoftTenant",
"model_specific_actions": [
"add",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"remove",
"tag",
"update"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hostName",
"title": "Host"
},
{
"name": "tenantUsername",
"title": "Admin Username"
},
{
"name": "tenant_id",
"title": "Tenant ID"
},
{
"name": "msol_user_api_page_size",
"title": "Max page size for MsolUser"
},
{
"name": "enable_exchange",
"title": "Enable Microsoft Exchange"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "655efa9b40d96fe47c23f417",
"meta": {
"tags": [],
"cached": true,
"title": "Auto Build Tenant",
"business_key": {},
"schema_version": "1.7",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "655efa9b40d96fe47c23f417",
"href": "/api/data/MicrosoftTenant/655efa9b40d96fe47c23f417/"
}
],
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/MicrosoftTenant/655efa9b40d96fe47c23f417/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/MicrosoftTenant/655efa9b40d96fe47c23f417/",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/MicrosoftTenant/655efa9b40d96fe47c23f417/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/MicrosoftTenant/655efa9b40d96fe47c23f417/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/MicrosoftTenant/655efa9b40d96fe47c23f417/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/MicrosoftTenant/655efa9b40d96fe47c23f417/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/MicrosoftTenant",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efa9b40d96fe47c23f417"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hostName",
"title": "Host"
},
{
"name": "tenantUsername",
"title": "Admin Username"
},
{
"name": "tenant_id",
"title": "Tenant ID"
},
{
"name": "msol_user_api_page_size",
"title": "Max page size for MsolUser"
},
{
"name": "enable_exchange",
"title": "Enable Microsoft Exchange"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"exchange_certificate_thumbprint": "==$TlyW5LP6pHyPKqsC$HiphUDX/tdHEoDn3vPo/Zi9rO07MusQLHWiyVt+/51c7JbDzqdfPfg==$==",
"use_proxy": false,
"pkid": "655efa9b40d96fe47c23f418",
"tenant_id": "6e6e313c-6fac-4f8d-a152-f8284f723f19",
"description": "Auto Build Tenant",
"hostName": "10.120.10.217",
"tenantPassword": "==$nn4aWL9MxbvuW7F5$YkEy/iqKl91W92VRrujAGrvQUlA=$==",
"proxyPassword": "==$TA5CrKcVI69xCoX4$2YfYAOZ8EOrf$==",
"name": "Auto Build Tenant",
"enable_exchange": true,
"graph_api_certificate_thumbprint": "3D8323C3239B5A3A428BE34BB2D33B12CAA0F614",
"version": "2019.1",
"proxyUsername": "WSMan-svc",
"client_id": "72f6e403-f9c6-4fb3-bc65-41d9425cabec",
"tenantUsername": "[email protected]",
"client_secret": "==$MiCM3cTIMyw4ij9J$0vc0cLfASt8jhSuMicHv5BN9Z5tj2yOK62fN6G99XRHT0XpNIDQx5g==$==",
"hierarchy_friendly_name": "VossAutoBuild (Customer)",
"powershellDeploymentMode": "onprem",
"auth_method": "SESSION",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild"
}
}
]
}
(Show the first instance)
{
"pkid": "655efa9b40d96fe47c23f417",
"meta": {
"tags": [],
"cached": false,
"title": "Auto Build Tenant",
"business_key": {},
"schema_version": "1.7",
"references": {
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"self": [
{
"pkid": "655efa9b40d96fe47c23f417",
"href": "/api/data/MicrosoftTenant/655efa9b40d96fe47c23f417/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/MicrosoftTenant/655efa9b40d96fe47c23f417/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/MicrosoftTenant/655efa9b40d96fe47c23f417/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/MicrosoftTenant/655efa9b40d96fe47c23f417/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/MicrosoftTenant/655efa9b40d96fe47c23f417/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/MicrosoftTenant/655efa9b40d96fe47c23f417/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/MicrosoftTenant/655efa9b40d96fe47c23f417/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/MicrosoftTenant",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efa9b40d96fe47c23f417"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "hostName",
"title": "Host"
},
{
"name": "tenantUsername",
"title": "Admin Username"
},
{
"name": "tenant_id",
"title": "Tenant ID"
},
{
"name": "msol_user_api_page_size",
"title": "Max page size for MsolUser"
},
{
"name": "enable_exchange",
"title": "Enable Microsoft Exchange"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"exchange_certificate_thumbprint": "==$TlyW5LP6pHyPKqsC$HiphUDX/tdHEoDn3vPo/Zi9rO07MusQLHWiyVt+/51c7JbDzqdfPfg==$==",
"proxyUsername": "WSMan-svc",
"use_proxy": false,
"pkid": "655efa9b40d96fe47c23f418",
"tenant_id": "6e6e313c-6fac-4f8d-a152-f8284f723f19",
"hostName": "10.120.10.217",
"proxyPassword": "==$TA5CrKcVI69xCoX4$2YfYAOZ8EOrf$==",
"name": "Auto Build Tenant",
"enable_exchange": true,
"graph_api_certificate_thumbprint": "3D8323C3239B5A3A428BE34BB2D33B12CAA0F614",
"version": "2019.1",
"tenantPassword": "==$nn4aWL9MxbvuW7F5$YkEy/iqKl91W92VRrujAGrvQUlA=$==",
"client_id": "72f6e403-f9c6-4fb3-bc65-41d9425cabec",
"tenantUsername": "[email protected]",
"client_secret": "==$MiCM3cTIMyw4ij9J$0vc0cLfASt8jhSuMicHv5BN9Z5tj2yOK62fN6G99XRHT0XpNIDQx5g==$==",
"powershellDeploymentMode": "onprem",
"auth_method": "SESSION",
"description": "Auto Build Tenant"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/MicrosoftTenant. | GET | /api/data/MicrosoftTenant/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/MicrosoftTenant as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/MicrosoftTenant/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/MicrosoftTenant/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/MicrosoftTenant; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/MicrosoftTenant/[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/MicrosoftTenant and the JSON format can be used to import instances of data/MicrosoftTenant.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/MicrosoftTenant/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/MicrosoftTenant/[pkid] | hierarchy=[hierarchy] | The data/MicrosoftTenant instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/MicrosoftTenant/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/MicrosoftTenant. |