[Index]
Model ref.: device/msteamsonline/CsTeamsTemplates
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": {
"OdataId": {
"name": "OdataId",
"type": "string",
"title": "Odata Id"
},
"Id": {
"name": "Id",
"type": "string",
"title": "Id"
},
"TemplateId": {
"name": "TemplateId",
"type": "string",
"title": "Template Id"
},
"App": {
"name": "App",
"type": "array",
"title": "App",
"description": "App",
"items": {
"type": "object",
"properties": {
"Id": {
"name": "Id",
"type": "string",
"title": "Id"
}
}
}
},
"AppCount": {
"name": "AppCount",
"type": "integer",
"title": "App Count",
"readonly": true
},
"Category": {
"name": "Category",
"type": "string",
"title": "Category",
"description": "Category"
},
"Channel": {
"name": "Channel",
"type": "array",
"title": "Channels",
"items": {
"type": "object",
"properties": {
"Id": {
"name": "Id",
"type": "string",
"title": "Id"
},
"DisplayName": {
"name": "DisplayName",
"type": "string",
"title": "Display Name"
},
"IsFavoriteByDefault": {
"name": "IsFavoriteByDefault",
"type": "boolean",
"title": "Is Favorite By Default"
},
"Tab": {
"name": "Tab",
"type": "array",
"title": "Tab",
"items": {
"type": "object",
"properties": {
"Configuration": {
"name": "Configuration",
"type": "string",
"title": "Configuration"
},
"Name": {
"name": "Name",
"type": "string",
"title": "Name"
},
"Id": {
"name": "Id",
"type": "string",
"title": "Id"
},
"Key": {
"name": "Key",
"type": "string",
"title": "Key"
},
"MessageId": {
"name": "MessageId",
"type": "string",
"title": "Message Id"
},
"SortOrderIndex": {
"name": "SortOrderIndex",
"type": "string",
"title": "Sort Order Index"
},
"TeamsAppId": {
"name": "TeamsAppId",
"type": "string",
"title": "Teams App Id"
},
"WebUrl": {
"name": "WebUrl",
"type": "string",
"title": "Web Url"
}
}
}
}
}
}
},
"ChannelCount": {
"name": "ChannelCount",
"type": "integer",
"title": "Channel Count",
"readonly": true
},
"Classification": {
"name": "Classification",
"type": "string",
"title": "Classification"
},
"Description": {
"name": "Description",
"type": "string",
"title": "Description"
},
"DiscoverySetting": {
"name": "DiscoverySetting",
"type": "object",
"title": "Discovery Settings",
"properties": {
"ShowInTeamsSearchAndSuggestion": {
"name": "ShowInTeamsSearchAndSuggestion",
"type": "boolean",
"readonly": true,
"title": "Show In Teams Search And Suggestions"
}
}
},
"DisplayName": {
"name": "DisplayName",
"type": "string",
"title": "Display Name"
},
"FunSetting": {
"name": "FunSetting",
"type": "object",
"title": "Fun Settings",
"properties": {
"AllowGiphy": {
"name": "AllowGiphy",
"type": "boolean",
"title": "Allow Giphy"
},
"GiphyContentRating": {
"name": "GiphyContentRating",
"type": "string",
"title": "Giphy Content Rating",
"description": "Giphy Content Rating"
},
"AllowStickersAndMeme": {
"name": "AllowStickersAndMeme",
"type": "boolean",
"title": "Allow Stickers And Memes"
},
"AllowCustomMeme": {
"name": "AllowCustomMeme",
"type": "boolean",
"title": "Allow Custom Memes"
}
}
},
"GuestSetting": {
"name": "GuestSetting",
"type": "object",
"title": "Guest Settings",
"properties": {
"AllowCreateUpdateChannel": {
"name": "AllowCreateUpdateChannel",
"type": "boolean",
"title": "Allow Create Update Channels"
},
"AllowDeleteChannel": {
"name": "AllowDeleteChannel",
"type": "boolean",
"title": "Allow Delete Channels"
}
}
},
"IsMembershipLimitedToOwner": {
"name": "IsMembershipLimitedToOwner",
"type": "boolean",
"title": "Is Membership Limited To Owners"
},
"LanguageTag": {
"name": "LanguageTag",
"type": "string",
"title": "Language Tag"
},
"LastModifiedDateTime": {
"name": "LastModifiedDateTime",
"type": "string",
"title": "Last Modified Date Time"
},
"LastModifiedBy": {
"name": "LastModifiedBy",
"type": "string",
"title": "Last Modified By",
"default": "'@odata.type': 'microsoft.graph.identitySet'"
},
"Locale": {
"name": "Locale",
"type": "string",
"title": "Locale"
},
"MemberSetting": {
"name": "MemberSetting",
"type": "object",
"title": "Member Settings",
"properties": {
"AllowCreateUpdateChannel": {
"name": "AllowCreateUpdateChannel",
"type": "boolean",
"title": "Allow Create Update Channels"
},
"AllowCreatePrivateChannel": {
"name": "AllowCreatePrivateChannel",
"type": "boolean",
"title": "Allow Create Private Channels"
},
"AllowDeleteChannel": {
"name": "AllowDeleteChannel",
"type": "boolean",
"title": "Allow Delete Channels"
},
"AllowAddRemoveApp": {
"name": "AllowAddRemoveApp",
"type": "boolean",
"title": "Allow Add Remove Apps"
},
"AllowCreateUpdateRemoveTab": {
"name": "AllowCreateUpdateRemoveTab",
"type": "boolean",
"title": "Allow Create Update Remove Tabs"
},
"AllowCreateUpdateRemoveConnector": {
"name": "AllowCreateUpdateRemoveConnector",
"type": "boolean",
"title": "Allow Create Update Remove Connectors"
},
"UploadCustomApp": {
"name": "UploadCustomApp",
"type": "boolean",
"title": "UploadCustomApp"
}
}
},
"MessagingSetting": {
"name": "MessagingSetting",
"type": "object",
"title": "Messaging Settings",
"properties": {
"AllowUserEditMessage": {
"name": "AllowUserEditMessage",
"type": "boolean",
"title": "Allow User Edit Messages"
},
"AllowUserDeleteMessage": {
"name": "AllowUserDeleteMessage",
"type": "boolean",
"title": "Allow User Delete Messages"
},
"AllowOwnerDeleteMessage": {
"name": "AllowOwnerDeleteMessage",
"type": "boolean",
"title": "Allow Owner Delete Messages"
},
"AllowTeamMention": {
"name": "AllowTeamMention",
"type": "boolean",
"title": "Allow Team Mentions"
},
"AllowChannelMention": {
"name": "AllowChannelMention",
"type": "boolean",
"title": "Allow Channel Mentions"
}
}
},
"Name": {
"name": "Name",
"type": "string",
"title": "Name"
},
"OwnerUserObjectId": {
"name": "OwnerUserObjectId",
"type": "string",
"title": "Owner User ObjectId"
},
"ParentTemplateId": {
"name": "ParentTemplateId",
"type": "string",
"title": "Parent Template Id"
},
"PublishedBy": {
"name": "PublishedBy",
"type": "string",
"title": "Published By"
},
"PublisherName": {
"name": "PublisherName",
"type": "string",
"title": "Publisher Name"
},
"ShortDescription": {
"name": "ShortDescription",
"type": "string",
"title": "Short Description"
},
"Specialization": {
"name": "Specialization",
"type": "string",
"title": "Specialization"
},
"Uri": {
"name": "Uri",
"type": "string",
"title": "Uri"
},
"Visibility": {
"name": "Visibility",
"type": "string",
"title": "Privacy",
"description": "Privacy"
}
},
"schema_version": "2019.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/msteamsonline/CsTeamsTemplates/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/msteamsonline/CsTeamsTemplates/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/msteamsonline/CsTeamsTemplates/[pkid1]", "/api/v0/device/msteamsonline/CsTeamsTemplates/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/msteamsonline/CsTeamsTemplates/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/msteamsonline/CsTeamsTemplates |
|
{"hrefs": ["/api/device/msteamsonline/CsTeamsTemplates/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/msteamsonline/CsTeamsTemplates |
|
{"hrefs": ["/api/device/msteamsonline/CsTeamsTemplates/[pkid1]", "/api/device/msteamsonline/CsTeamsTemplates/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/msteamsonline/CsTeamsTemplates; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/msteamsonline/CsTeamsTemplates/export/ |
|
{ "hrefs":["/api/device/msteamsonline/CsTeamsTemplates/[pkid1]", "/api/device/msteamsonline/CsTeamsTemplates/[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/msteamsonline/CsTeamsTemplates and the JSON format can be used to import instances of device/msteamsonline/CsTeamsTemplates.
GET http://[host-proxy]/api/device/msteamsonline/CsTeamsTemplates/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/msteamsonline/CsTeamsTemplates | POST | /api/device/msteamsonline/CsTeamsTemplates/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/device/msteamsonline/CsTeamsTemplates/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/msteamsonline/CsTeamsTemplates/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/msteamsonline/CsTeamsTemplates/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/device/msteamsonline/CsTeamsTemplates/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/msteamsonline/CsTeamsTemplates/ |
|
The device/msteamsonline/CsTeamsTemplates schema and all instances as JSON. |
(The list will return 0 to 3 device/msteamsonline/CsTeamsTemplates instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 15,
"total_limit": null,
"order_by": "DisplayName",
"direction": "asc",
"current": "/api/device/msteamsonline/CsTeamsTemplates/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=down"
},
"operations": [
"list"
],
"meta": {
"model_type": "device/msteamsonline/CsTeamsTemplates",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "ShortDescription",
"title": "Short Description"
},
{
"name": "PublishedBy",
"title": "Published By"
},
{
"name": "TemplateId",
"title": "Template Id"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"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": [
"list",
"get",
"move",
"export",
"export_bulkload_template",
"bulk_update_form",
"configuration_template",
"field_display_policy",
"help",
"migration",
"transform",
"tag_version"
],
"schema_version": "2019.1",
"actions": [
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/msteamsonline/CsTeamsTemplates/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/msteamsonline/CsTeamsTemplates",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/msteamsonline/CsTeamsTemplates/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/device/msteamsonline/CsTeamsTemplates/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/device/msteamsonline/CsTeamsTemplates/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/msteamsonline/CsTeamsTemplates/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/msteamsonline/CsTeamsTemplates/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/device/msteamsonline/CsTeamsTemplates/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/msteamsonline/CsTeamsTemplates/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/msteamsonline/CsTeamsTemplates/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/msteamsonline/CsTeamsTemplates/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
},
{
"transform": {
"method": "GET",
"class": "transform",
"href": "/api/device/msteamsonline/CsTeamsTemplates/transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Transform Template"
}
}
]
},
"resources": [
{
"data": {
"Category": [
"General"
],
"ChannelCount": 5,
"DisplayName": "Adopt Office 365",
"Description": "Help build, grow, and sustain your Champions community rollout by evangelizing and helping your peers with the new technology.",
"Locale": "en-US",
"Visibility": "Private",
"OdataId": "/api/teamtemplates/v1.0/com.microsoft.teams.template.AdoptOffice365/Public/en-US",
"hierarchy": "6644e9bcf14dbdc7695d37d1",
"AppCount": 3,
"TemplateId": "com.microsoft.teams.template.AdoptOffice365",
"PublishedBy": "Microsoft",
"ShortDescription": "Create a Champion community to drive adoption.",
"Id": "com.microsoft.teams.template.AdoptOffice365",
"Name": "Adopt Office 365",
"summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.RND",
"hierarchy_friendly_name": "RND (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.RND"
},
"meta": {
"model_type": "device/msteamsonline/CsTeamsTemplates",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "ShortDescription",
"title": "Short Description"
},
{
"name": "PublishedBy",
"title": "Published By"
},
{
"name": "TemplateId",
"title": "Template Id"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "Adopt Office 365",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/MSTeamsOnline/6644f420f14dbdc7695ec116",
"pkid": "6644f420f14dbdc7695ec116"
}
],
"parent": [
{
"pkid": "6644e9bcf14dbdc7695d37d1",
"href": "/api/data/HierarchyNode/6644e9bcf14dbdc7695d37d1"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ff14dbdc7695fcaf6/",
"pkid": "6644f78ff14dbdc7695fcaf6"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89bd5affa931cce3863f9",
"6644e9bcf14dbdc7695d37d1",
"6644f78ff14dbdc7695fcaf6"
],
"schema_version": "",
"actions": [
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/6644f78ff14dbdc7695fcaf6/?model_type=device/msteamsonline/CsTeamsTemplates",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ff14dbdc7695fcaf6/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ff14dbdc7695fcaf6/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ff14dbdc7695fcaf6/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ff14dbdc7695fcaf6/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ff14dbdc7695fcaf6/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "6644f78ff14dbdc7695fcaf6"
},
{
"data": {
"Category": [
"Financial Services"
],
"ChannelCount": 12,
"DisplayName": "Bank Branch",
"Description": "Centralize collaboration for your bank branch employees across huddles, customer meetings, and business processes such as mortgage collaboration. Also, keep everyone in the loop with announcements and kudos.",
"Locale": "en-US",
"Visibility": "Private",
"OdataId": "/api/teamtemplates/v1.0/com.microsoft.teams.template.CollaborateWithinABankBranch/Public/en-US",
"hierarchy": "6644e9bcf14dbdc7695d37d1",
"AppCount": 7,
"TemplateId": "com.microsoft.teams.template.CollaborateWithinABankBranch",
"PublishedBy": "Microsoft",
"ShortDescription": "Create a place for bank branch collaboration.",
"Id": "com.microsoft.teams.template.CollaborateWithinABankBranch",
"Name": "Bank Branch",
"summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.RND",
"hierarchy_friendly_name": "RND (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.RND"
},
"meta": {
"model_type": "device/msteamsonline/CsTeamsTemplates",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "ShortDescription",
"title": "Short Description"
},
{
"name": "PublishedBy",
"title": "Published By"
},
{
"name": "TemplateId",
"title": "Template Id"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "Bank Branch",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/MSTeamsOnline/6644f420f14dbdc7695ec116",
"pkid": "6644f420f14dbdc7695ec116"
}
],
"parent": [
{
"pkid": "6644e9bcf14dbdc7695d37d1",
"href": "/api/data/HierarchyNode/6644e9bcf14dbdc7695d37d1"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ef14dbdc7695fcae7/",
"pkid": "6644f78ef14dbdc7695fcae7"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89bd5affa931cce3863f9",
"6644e9bcf14dbdc7695d37d1",
"6644f78ef14dbdc7695fcae7"
],
"schema_version": "",
"actions": [
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/6644f78ef14dbdc7695fcae7/?model_type=device/msteamsonline/CsTeamsTemplates",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ef14dbdc7695fcae7/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ef14dbdc7695fcae7/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ef14dbdc7695fcae7/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ef14dbdc7695fcae7/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ef14dbdc7695fcae7/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "6644f78ef14dbdc7695fcae7"
},
{
"data": {
"Category": [
"Financial Services"
],
"ChannelCount": 5,
"DisplayName": "Crisis Communications",
"Description": "Centralize collaboration for your crisis team across business units and help create business continuity plans, share remote working tips, track customer communication, and keep everyone in the loop with announcements and news.",
"Locale": "en-US",
"Visibility": "Private",
"OdataId": "/api/teamtemplates/v1.0/com.microsoft.teams.template.CollaborateOnAGlobalCrisisOrEvent/Public/en-US",
"hierarchy": "6644e9bcf14dbdc7695d37d1",
"AppCount": 7,
"TemplateId": "com.microsoft.teams.template.CollaborateOnAGlobalCrisisOrEvent",
"PublishedBy": "Microsoft",
"ShortDescription": "Create a place for your team to coordinate on a major crisis.",
"Id": "com.microsoft.teams.template.CollaborateOnAGlobalCrisisOrEvent",
"Name": "Crisis Communications",
"summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.RND",
"hierarchy_friendly_name": "RND (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.RND"
},
"meta": {
"model_type": "device/msteamsonline/CsTeamsTemplates",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "ShortDescription",
"title": "Short Description"
},
{
"name": "PublishedBy",
"title": "Published By"
},
{
"name": "TemplateId",
"title": "Template Id"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "Crisis Communications",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/MSTeamsOnline/6644f420f14dbdc7695ec116",
"pkid": "6644f420f14dbdc7695ec116"
}
],
"parent": [
{
"pkid": "6644e9bcf14dbdc7695d37d1",
"href": "/api/data/HierarchyNode/6644e9bcf14dbdc7695d37d1"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ef14dbdc7695fcae4/",
"pkid": "6644f78ef14dbdc7695fcae4"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89bd5affa931cce3863f9",
"6644e9bcf14dbdc7695d37d1",
"6644f78ef14dbdc7695fcae4"
],
"schema_version": "",
"actions": [
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/6644f78ef14dbdc7695fcae4/?model_type=device/msteamsonline/CsTeamsTemplates",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ef14dbdc7695fcae4/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ef14dbdc7695fcae4/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ef14dbdc7695fcae4/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ef14dbdc7695fcae4/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ef14dbdc7695fcae4/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "6644f78ef14dbdc7695fcae4"
}
]
}
(Show the first instance)
{
"data": {
"Category": [
"General"
],
"ChannelCount": 5,
"DisplayName": "Adopt Office 365",
"Description": "Help build, grow, and sustain your Champions community rollout by evangelizing and helping your peers with the new technology.",
"Locale": "en-US",
"Visibility": "Private",
"OdataId": "/api/teamtemplates/v1.0/com.microsoft.teams.template.AdoptOffice365/Public/en-US",
"hierarchy": "6644e9bcf14dbdc7695d37d1",
"AppCount": 3,
"TemplateId": "com.microsoft.teams.template.AdoptOffice365",
"PublishedBy": "Microsoft",
"ShortDescription": "Create a Champion community to drive adoption.",
"Id": "com.microsoft.teams.template.AdoptOffice365",
"Name": "Adopt Office 365"
},
"meta": {
"model_type": "device/msteamsonline/CsTeamsTemplates",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "ShortDescription",
"title": "Short Description"
},
{
"name": "PublishedBy",
"title": "Published By"
},
{
"name": "TemplateId",
"title": "Template Id"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "Adopt Office 365",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/MSTeamsOnline/6644f420f14dbdc7695ec116",
"pkid": "6644f420f14dbdc7695ec116"
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/6644e9bcf14dbdc7695d37d1",
"pkid": "6644e9bcf14dbdc7695d37d1"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ff14dbdc7695fcaf6/",
"pkid": "6644f78ff14dbdc7695fcaf6"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89bd5affa931cce3863f9",
"6644e9bcf14dbdc7695d37d1",
"6644f78ff14dbdc7695fcaf6"
],
"schema_version": "",
"actions": [
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/6644f78ff14dbdc7695fcaf6/?hierarchy=[hierarchy]&model_type=device/msteamsonline/CsTeamsTemplates",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ff14dbdc7695fcaf6/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ff14dbdc7695fcaf6/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ff14dbdc7695fcaf6/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ff14dbdc7695fcaf6/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/msteamsonline/CsTeamsTemplates/6644f78ff14dbdc7695fcaf6/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"pkid": "6644f78ff14dbdc7695fcaf6"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/msteamsonline/CsTeamsTemplates. | GET | /api/device/msteamsonline/CsTeamsTemplates/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/msteamsonline/CsTeamsTemplates as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/msteamsonline/CsTeamsTemplates/purge/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Transform Template | GET | /api/device/msteamsonline/CsTeamsTemplates/transform/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/msteamsonline/CsTeamsTemplates | 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/msteamsonline/CsTeamsTemplates; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/msteamsonline/CsTeamsTemplates/[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/msteamsonline/CsTeamsTemplates and the JSON format can be used to import instances of device/msteamsonline/CsTeamsTemplates.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/msteamsonline/CsTeamsTemplates/[pkid] | hierarchy=[hierarchy] | The device/msteamsonline/CsTeamsTemplates instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/msteamsonline/CsTeamsTemplates/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/msteamsonline/CsTeamsTemplates. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/msteamsonline/CsTeamsTemplates/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |