[Index]
Model ref.: relation/MicrosoftTeams
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": {
"guestSettings": {
"properties": {
"allowCreateUpdateChannels": {
"type": "boolean",
"name": "allowCreateUpdateChannels",
"title": "Allow Create Update Channels"
},
"allowDeleteChannels": {
"type": "boolean",
"name": "allowDeleteChannels",
"title": "Allow Delete Channels"
}
},
"title": "Guest Settings",
"type": "object",
"name": "guestSettings",
"description": "Settings to configure whether guests can create, update, or delete channels in the team."
},
"memberSettings": {
"properties": {
"allowAddRemoveApps": {
"type": "boolean",
"name": "allowAddRemoveApps",
"title": "Allow Add Remove Apps"
},
"allowDeleteChannels": {
"type": "boolean",
"name": "allowDeleteChannels",
"title": "Allow Delete Channels"
},
"allowCreateUpdateChannels": {
"type": "boolean",
"name": "allowCreateUpdateChannels",
"title": "Allow Create Update Channels"
},
"allowCreatePrivateChannels": {
"type": "boolean",
"name": "allowCreatePrivateChannels",
"title": "Allow Create Private Channels"
},
"allowCreateUpdateRemoveTabs": {
"type": "boolean",
"name": "allowCreateUpdateRemoveTabs",
"title": "Allow Create Update Remove Tabs"
},
"allowCreateUpdateRemoveConnectors": {
"type": "boolean",
"name": "allowCreateUpdateRemoveConnectors",
"title": "Allow Create Update Remove Connectors"
}
},
"title": "Member Settings",
"type": "object",
"name": "memberSettings",
"description": "Settings to configure whether members can perform certain actions, for example, create channels and add bots, in the team."
},
"displayName": {
"required": true,
"title": "Display Name",
"type": "string",
"name": "displayName",
"description": "Name of the team to be added or updated."
},
"description": {
"title": "Description",
"type": "string",
"name": "description",
"description": "An optional description for the team. Maximum length: 1024 characters."
},
"messagingSettings": {
"properties": {
"allowTeamMentions": {
"type": "boolean",
"name": "allowTeamMentions",
"title": "Allow Team Mentions"
},
"allowOwnerDeleteMessages": {
"type": "boolean",
"name": "allowOwnerDeleteMessages",
"title": "Allow Owner Delete Messages"
},
"allowUserDeleteMessages": {
"type": "boolean",
"name": "allowUserDeleteMessages",
"title": "Allow User Delete Messages"
},
"allowChannelMentions": {
"type": "boolean",
"name": "allowChannelMentions",
"title": "Allow Channel Mentions"
},
"allowUserEditMessages": {
"type": "boolean",
"name": "allowUserEditMessages",
"title": "Allow User Edit Messages"
}
},
"title": "Messaging Settings",
"type": "object",
"name": "messagingSettings",
"description": "Settings to configure messaging and mentions in the team."
},
"teamsTemplates": {
"type": "string",
"name": "teamsTemplates",
"title": "Teams Templates"
},
"channels": {
"items": {
"type": "object",
"properties": {
"email": {
"title": "Email",
"type": "string",
"name": "email",
"description": "Email of team channel."
},
"displayName": {
"title": "Display Name",
"type": "string",
"name": "displayName",
"description": "Display name of team channel member can be set on add and also be updated."
},
"description": {
"title": "Description",
"type": "string",
"name": "description",
"description": "Description of team channel member can be set on add and also be updated."
},
"membershipType": {
"name": "membershipType",
"title": "Membership Type",
"default": "standard",
"choices": [
{
"value": "standard",
"title": "Standard"
},
{
"value": "private",
"title": "Private"
},
{
"value": "shared",
"title": "Shared"
}
],
"type": "string",
"description": "Shows if a channel is a private, standard, or shared channel. You cannot update the Membership Type value for an existing channel."
},
"id": {
"title": "Id",
"type": "string",
"name": "id",
"description": "Id of team channel."
}
}
},
"title": "Channels",
"type": "array",
"name": "channels",
"description": "The collection of channels and messages associated with the team. Changes to a team, such as adding or removing members, can take up to 10 minutes to appear in search results."
},
"visibility": {
"description": "The visibility of the group and team. Defaults to Public.",
"choices": [
{
"value": "public",
"title": "Public"
},
{
"value": "private",
"title": "Private"
}
],
"type": "string",
"name": "visibility",
"title": "Privacy"
},
"members": {
"description": "Members and owners of the team. Changes to a team, such as adding or removing members, can take up to 10 minutes to appear in search results.",
"title": "Members",
"items": {
"type": "object",
"properties": {
"username": {
"name": "username",
"format": "uri",
"description": "Username.",
"title": "Username",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "UserPrincipalName",
"target_model_type": "device/msgraph/MsolUser",
"type": "string",
"target": "/api/device/msgraph/MsolUser/choices/?field=UserPrincipalName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"displayName": {
"type": "string",
"name": "displayName",
"title": "Display Name"
},
"role": {
"description": "Shows whether a user in the list is a team owner or member.",
"title": "Role",
"default": "member",
"choices": [
{
"value": "owner",
"title": "Owner"
},
{
"value": "member",
"title": "Member"
}
],
"type": "string",
"name": "role"
},
"id": {
"type": "string",
"name": "id",
"title": "Id"
}
}
},
"required": true,
"type": "array",
"name": "members"
},
"isArchived": {
"readonly": true,
"title": "Is Archived",
"type": "boolean",
"name": "isArchived",
"description": "Whether this team is in read-only mode."
},
"isMembershipLimitedToOwners": {
"type": "boolean",
"name": "isMembershipLimitedToOwners",
"title": "Is Membership Limited To Owners"
},
"discoverySettings": {
"properties": {
"showInTeamsSearchAndSuggestions": {
"readonly": true,
"type": "boolean",
"name": "showInTeamsSearchAndSuggestions",
"title": "Show In Teams Search And Suggestions"
}
},
"type": "object",
"name": "discoverySettings",
"title": "Discovery Settings"
},
"id": {
"title": "Id",
"type": "string",
"name": "id",
"description": "Id of Team"
},
"noinstance": {
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"type": "array",
"maxItems": 1,
"title": "Noinstance"
},
"funSettings": {
"properties": {
"allowStickersAndMemes": {
"type": "boolean",
"name": "allowStickersAndMemes",
"title": "Allow Stickers And Memes"
},
"allowGiphy": {
"type": "boolean",
"name": "allowGiphy",
"title": "Allow Giphy"
},
"giphyContentRating": {
"description": "Giphy Content Rating",
"choices": [
{
"value": "moderate",
"title": "Moderate"
},
{
"value": "strict",
"title": "Strict"
}
],
"type": "string",
"name": "giphyContentRating",
"title": "Giphy Content Rating"
},
"allowCustomMemes": {
"type": "boolean",
"name": "allowCustomMemes",
"title": "Allow Custom Memes"
}
},
"title": "Fun Settings",
"type": "object",
"name": "funSettings",
"description": "Settings to configure use of Giphy, memes, and stickers in the team."
}
},
"schema_version": "0.2"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/MicrosoftTeams/add/ |
|
The GUI Add form of relation/MicrosoftTeams 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/relation/MicrosoftTeams | 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/relation/MicrosoftTeams/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/MicrosoftTeams/[pkid1]", "/api/relation/MicrosoftTeams/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/MicrosoftTeams/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/MicrosoftTeams |
|
{"hrefs": ["/api/relation/MicrosoftTeams/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/MicrosoftTeams |
|
{"hrefs": ["/api/relation/MicrosoftTeams/[pkid1]", "/api/relation/MicrosoftTeams/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/MicrosoftTeams; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/MicrosoftTeams/export/ |
|
{ "hrefs":["/api/relation/MicrosoftTeams/[pkid1]", "/api/relation/MicrosoftTeams/[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 relation/MicrosoftTeams and the JSON format can be used to import instances of relation/MicrosoftTeams.
GET http://[host-proxy]/api/relation/MicrosoftTeams/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/MicrosoftTeams | POST | /api/relation/MicrosoftTeams/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/MicrosoftTeams/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/MicrosoftTeams/ |
|
The relation/MicrosoftTeams schema and all instances as JSON. |
(The list will return 0 to 3 relation/MicrosoftTeams instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"move",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "displayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/MicrosoftTeams/?skip=0&limit=3&order_by=displayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 8
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "0.2",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/MicrosoftTeams/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/MicrosoftTeams/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/MicrosoftTeams/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/MicrosoftTeams",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/MicrosoftTeams/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/MicrosoftTeams/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/relation/MicrosoftTeams/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/MicrosoftTeams/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
}
],
"model_type": "relation/MicrosoftTeams",
"model_specific_actions": [
"field_display_policy",
"get",
"export_bulkload_template",
"move",
"list",
"update",
"remove",
"add",
"export"
],
"summary_attrs": [
{
"name": "displayName",
"title": "Display Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "visibility",
"title": "Privacy"
},
{
"name": "isArchived",
"title": "Is Archived"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "655efdfb40d96fe47c25427b",
"meta": {
"tags": [],
"cached": true,
"title": "AAA_Team",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "655efa9c40d96fe47c23f429",
"href": "/api/v0/data/MSGraph/655efa9c40d96fe47c23f429"
}
],
"self": [
{
"pkid": "655efdfb40d96fe47c25427b",
"href": "/api/relation/MicrosoftTeams/655efdfb40d96fe47c25427b/"
}
],
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/MicrosoftTeams/655efdfb40d96fe47c25427b/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/MicrosoftTeams/655efdfb40d96fe47c25427b/",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/655efdfb40d96fe47c25427b/?model_type=relation/MicrosoftTeams",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/MicrosoftTeams/655efdfb40d96fe47c25427b/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/MicrosoftTeams/655efdfb40d96fe47c25427b/",
"method": "GET",
"title": "Get"
}
},
{
"archive_team": {
"support_async": true,
"class": "custom",
"href": "/api/relation/MicrosoftTeams/655efdfb40d96fe47c25427b/+archive_team/",
"method": "POST",
"title": "Archive Team"
}
},
{
"unarchive_team": {
"support_async": true,
"class": "custom",
"href": "/api/relation/MicrosoftTeams/655efdfb40d96fe47c25427b/+unarchive_team/",
"method": "POST",
"title": "Unarchive Team"
}
}
],
"model_type": "relation/MicrosoftTeams",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efdfb40d96fe47c25427b"
],
"summary_attrs": [
{
"name": "displayName",
"title": "Display Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "visibility",
"title": "Privacy"
},
{
"name": "isArchived",
"title": "Is Archived"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"displayName": "AAA_Team",
"description": "Team of AAAs",
"hierarchy": "655ef9d340d96fe47c238be3",
"channels": [
{
"id": "19:[email protected]",
"displayName": "General",
"email": "[email protected]",
"membershipType": "standard",
"description": "Team of AAAs"
}
],
"members": [
{
"username": "[email protected]",
"displayName": "Admin PT",
"role": "owner",
"id": "MCMjMSMjNmU2ZTMxM2MtNmZhYy00ZjhkLWExNTItZjgyODRmNzIzZjE5IyNjMmU2NTlhZS02NDQ5LTRhMjMtYmQ4Ni1hMDI2YmU1ZGNjOTcjI2VhY2I4Y2RkLTg4MTUtNDMxZi05OTE1LTI3OTVmZTQ0NjA4Zg=="
}
],
"hierarchy_friendly_name": "VossAutoBuild (Customer)",
"summary_device": "Connection parameters for Microsoft Graph Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild",
"id": "c2e659ae-6449-4a23-bd86-a026be5dcc97",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild"
}
},
{
"pkid": "655efdfe40d96fe47c2543f8",
"meta": {
"tags": [],
"cached": true,
"title": "Deployment team",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "655efa9c40d96fe47c23f429",
"href": "/api/v0/data/MSGraph/655efa9c40d96fe47c23f429"
}
],
"self": [
{
"pkid": "655efdfe40d96fe47c2543f8",
"href": "/api/relation/MicrosoftTeams/655efdfe40d96fe47c2543f8/"
}
],
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/relation/MicrosoftTeams/655efdfe40d96fe47c2543f8/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/relation/MicrosoftTeams/655efdfe40d96fe47c2543f8/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/655efdfe40d96fe47c2543f8/?model_type=relation/MicrosoftTeams",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/MicrosoftTeams/655efdfe40d96fe47c2543f8/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/relation/MicrosoftTeams/655efdfe40d96fe47c2543f8/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"archive_team": {
"support_async": true,
"href": "/api/relation/MicrosoftTeams/655efdfe40d96fe47c2543f8/+archive_team/",
"title": "Archive Team",
"class": "custom",
"method": "POST"
}
},
{
"unarchive_team": {
"support_async": true,
"href": "/api/relation/MicrosoftTeams/655efdfe40d96fe47c2543f8/+unarchive_team/",
"title": "Unarchive Team",
"class": "custom",
"method": "POST"
}
}
],
"model_type": "relation/MicrosoftTeams",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efdfe40d96fe47c2543f8"
],
"summary_attrs": [
{
"name": "displayName",
"title": "Display Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "visibility",
"title": "Privacy"
},
{
"name": "isArchived",
"title": "Is Archived"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"displayName": "Deployment team",
"description": "This team helps you to roll out Teams across your organization. Each workload that you want to roll out will create a new dedicated channel. First instance localize team. The second instance of Teams is the product name and should not be localized.",
"hierarchy": "655ef9d340d96fe47c238be3",
"channels": [
{
"displayName": "Chat, teams, channels and apps",
"description": "Resources for deploying Chat, teams, channels and apps.",
"membershipType": "standard",
"id": "19:[email protected]"
},
{
"displayName": "General",
"description": "This team helps you to roll out Teams across your organization. Each workload that you want to roll out will create a new dedicated channel. First instance localize team. The second instance of Teams is the product name and should not be localized.",
"membershipType": "standard",
"id": "19:[email protected]"
}
],
"members": [
{
"username": "[email protected]",
"displayName": "CC_RA_2",
"role": "member",
"id": "MCMjMSMjNmU2ZTMxM2MtNmZhYy00ZjhkLWExNTItZjgyODRmNzIzZjE5IyNiOGY4MDE4Ny0xNzljLTQ1ODgtOGM2Yi1jYWE3Mzg4MjIwMmQjIzAyOGRmMjFlLWE3NjUtNDdkNS05YTYwLWMxMWQ5ZGFiMGZiOQ=="
},
{
"username": "Aposs'[email protected]",
"displayName": "A\u2019poss 555",
"role": "member",
"id": "MCMjMSMjNmU2ZTMxM2MtNmZhYy00ZjhkLWExNTItZjgyODRmNzIzZjE5IyNiOGY4MDE4Ny0xNzljLTQ1ODgtOGM2Yi1jYWE3Mzg4MjIwMmQjIzY3ZGFkZTkzLThlY2YtNDFlZC05ZGY0LWE2YjBmOGU1MGVjYQ=="
},
{
"username": "[email protected]",
"displayName": "AA_RA_1",
"role": "member",
"id": "MCMjMSMjNmU2ZTMxM2MtNmZhYy00ZjhkLWExNTItZjgyODRmNzIzZjE5IyNiOGY4MDE4Ny0xNzljLTQ1ODgtOGM2Yi1jYWE3Mzg4MjIwMmQjI2MxYTczOWQzLWNiZDctNDU4My1hMWIwLTI4OTEwNWNiMGVlNw=="
},
{
"username": "[email protected]",
"displayName": "Admin PT",
"role": "owner",
"id": "MCMjMSMjNmU2ZTMxM2MtNmZhYy00ZjhkLWExNTItZjgyODRmNzIzZjE5IyNiOGY4MDE4Ny0xNzljLTQ1ODgtOGM2Yi1jYWE3Mzg4MjIwMmQjI2VhY2I4Y2RkLTg4MTUtNDMxZi05OTE1LTI3OTVmZTQ0NjA4Zg=="
}
],
"hierarchy_friendly_name": "VossAutoBuild (Customer)",
"summary_device": "Connection parameters for Microsoft Graph Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild",
"id": "b8f80187-179c-4588-8c6b-caa73882202d",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild"
}
},
{
"pkid": "655efdfc40d96fe47c2542b7",
"meta": {
"tags": [],
"cached": true,
"title": "GrantTeam",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "655efa9c40d96fe47c23f429",
"href": "/api/v0/data/MSGraph/655efa9c40d96fe47c23f429"
}
],
"self": [
{
"pkid": "655efdfc40d96fe47c2542b7",
"href": "/api/relation/MicrosoftTeams/655efdfc40d96fe47c2542b7/"
}
],
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/relation/MicrosoftTeams/655efdfc40d96fe47c2542b7/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/relation/MicrosoftTeams/655efdfc40d96fe47c2542b7/",
"class": "delete",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/655efdfc40d96fe47c2542b7/?model_type=relation/MicrosoftTeams",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/relation/MicrosoftTeams/655efdfc40d96fe47c2542b7/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/relation/MicrosoftTeams/655efdfc40d96fe47c2542b7/",
"class": "get",
"title": "Get"
}
},
{
"archive_team": {
"support_async": true,
"method": "POST",
"href": "/api/relation/MicrosoftTeams/655efdfc40d96fe47c2542b7/+archive_team/",
"class": "custom",
"title": "Archive Team"
}
},
{
"unarchive_team": {
"support_async": true,
"method": "POST",
"href": "/api/relation/MicrosoftTeams/655efdfc40d96fe47c2542b7/+unarchive_team/",
"class": "custom",
"title": "Unarchive Team"
}
}
],
"model_type": "relation/MicrosoftTeams",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efdfc40d96fe47c2542b7"
],
"summary_attrs": [
{
"name": "displayName",
"title": "Display Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "visibility",
"title": "Privacy"
},
{
"name": "isArchived",
"title": "Is Archived"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"displayName": "GrantTeam",
"description": "GrantTeam",
"hierarchy": "655ef9d340d96fe47c238be3",
"channels": [
{
"id": "19:[email protected]",
"displayName": "General",
"email": "[email protected]",
"membershipType": "standard",
"description": "GrantTeam"
}
],
"members": [
{
"username": "[email protected]",
"displayName": "Adele Vance",
"role": "owner",
"id": "MCMjMSMjNmU2ZTMxM2MtNmZhYy00ZjhkLWExNTItZjgyODRmNzIzZjE5IyM1OGE4YzllMC05OGQ5LTQxYmYtOWVmNC1jZThjNTU0YWZkZDUjIzUzYzFiOWIwLTRmNDYtNDllMS1iMjYzLTI3ZmQ2MzE3ZDFjMg=="
}
],
"hierarchy_friendly_name": "VossAutoBuild (Customer)",
"summary_device": "Connection parameters for Microsoft Graph Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild",
"id": "58a8c9e0-98d9-41bf-9ef4-ce8c554afdd5",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild"
}
}
]
}
(Show the first instance)
{
"pkid": "655efdfb40d96fe47c25427b",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "AAA_Team",
"business_key": {},
"schema_version": "0.2",
"references": {
"device": [
{
"pkid": "655efa9c40d96fe47c23f429",
"href": "/api/v0/data/MSGraph/655efa9c40d96fe47c23f429"
}
],
"self": [
{
"pkid": "655efdfb40d96fe47c25427b",
"href": "/api/relation/MicrosoftTeams/655efdfb40d96fe47c25427b/"
}
],
"children": [],
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/MicrosoftTeams/655efdfb40d96fe47c25427b/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/MicrosoftTeams/655efdfb40d96fe47c25427b/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/655efdfb40d96fe47c25427b/?hierarchy=[hierarchy]&model_type=relation/MicrosoftTeams",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/MicrosoftTeams/655efdfb40d96fe47c25427b/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/MicrosoftTeams/655efdfb40d96fe47c25427b/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"archive_team": {
"support_async": true,
"class": "custom",
"href": "/api/relation/MicrosoftTeams/655efdfb40d96fe47c25427b/+archive_team/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Archive Team"
}
},
{
"unarchive_team": {
"support_async": true,
"class": "custom",
"href": "/api/relation/MicrosoftTeams/655efdfb40d96fe47c25427b/+unarchive_team/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Unarchive Team"
}
}
],
"model_type": "relation/MicrosoftTeams",
"summary_attrs": [
{
"name": "displayName",
"title": "Display Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "visibility",
"title": "Privacy"
},
{
"name": "isArchived",
"title": "Is Archived"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"displayName": "AAA_Team",
"description": "Team of AAAs",
"channels": [
{
"description": "Team of AAAs",
"displayName": "General",
"id": "19:[email protected]",
"membershipType": "standard",
"email": "[email protected]"
}
],
"members": [
{
"username": "[email protected]",
"role": "owner",
"displayName": "Admin PT",
"id": "MCMjMSMjNmU2ZTMxM2MtNmZhYy00ZjhkLWExNTItZjgyODRmNzIzZjE5IyNjMmU2NTlhZS02NDQ5LTRhMjMtYmQ4Ni1hMDI2YmU1ZGNjOTcjI2VhY2I4Y2RkLTg4MTUtNDMxZi05OTE1LTI3OTVmZTQ0NjA4Zg=="
}
],
"id": "c2e659ae-6449-4a23-bd86-a026be5dcc97",
"noinstance": []
}
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/MicrosoftTeams/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/MicrosoftTeams/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/MicrosoftTeams | 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 relation/MicrosoftTeams; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/MicrosoftTeams/[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 relation/MicrosoftTeams and the JSON format can be used to import instances of relation/MicrosoftTeams.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/MicrosoftTeams/[pkid] | hierarchy=[hierarchy] | The relation/MicrosoftTeams instance with [pkid]. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Archive Team | POST | /api/relation/MicrosoftTeams/[pkid]/+archive_team | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Unarchive Team | POST | /api/relation/MicrosoftTeams/[pkid]/+unarchive_team | hierarchy=[hierarchy] | If payload required: |