{ "swagger": "2.0", "info": { "title": "D365 - Online Management", "description": "Online Management API lets you manage online instances of Customer Engagement in your Office 365 tenants.", "version": "1.0" }, "host": "admin.services.crm6.dynamics.com", "basePath": "/api/v1.2", "schemes": [ "https" ], "consumes": [], "produces": [], "paths": { "/Instances": { "get": { "responses": { "default": { "description": "default", "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id" }, "UniqueName": { "type": "string", "description": "UniqueName" }, "Version": { "type": "string", "description": "Version" }, "ApplicationUrl": { "type": "string", "description": "ApplicationUrl" }, "ApiUrl": { "type": "string", "description": "ApiUrl" }, "State": { "type": "string", "description": "State" }, "InitialUserPrincipalName": { "type": "string", "description": "InitialUserPrincipalName" }, "StateIsSupportedForDelete": { "type": "boolean", "description": "StateIsSupportedForDelete" }, "AdminMode": { "type": "boolean", "description": "AdminMode" }, "Type": { "type": "string", "description": "Type" }, "Purpose": { "type": "string", "description": "Purpose" }, "FriendlyName": { "type": "string", "description": "FriendlyName" }, "DomainName": { "type": "string", "description": "DomainName" }, "BaseLanguage": { "type": "integer", "format": "int32", "description": "BaseLanguage" }, "InitialUserEmail": { "type": "string", "description": "InitialUserEmail" }, "SecurityGroupId": { "type": "string", "description": "SecurityGroupId" }, "AdditionalProperties": { "type": "object", "properties": { "EffectiveUsedStorageMB": { "type": "string", "description": "EffectiveUsedStorageMB" }, "CreatedOnUTC": { "type": "string", "description": "CreatedOnUTC" }, "ExpirationDateUTC": { "type": "string", "description": "ExpirationDateUTC" }, "AdminMode": { "type": "string", "description": "AdminMode" }, "AdminModeCustomMessage": { "type": "string", "description": "AdminModeCustomMessage" }, "NotifyEmails": { "type": "string", "description": "NotifyEmails" } }, "description": "AdditionalProperties" } } } } } }, "summary": "Get instances", "operationId": "Get-Instances", "parameters": [], "description": "Retrieves all Customer Engagement instances in your Office 365 tenant." } }, "/InstanceBackups": { "get": { "responses": { "default": { "description": "default", "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id" }, "Status": { "type": "string", "description": "Status" }, "CreatedBy": { "type": "string", "description": "CreatedBy" }, "CreatedOn": { "type": "string", "description": "CreatedOn" }, "ExpiresOn": { "type": "string", "description": "ExpiresOn" }, "Version": { "type": "string", "description": "Version" }, "Notes": { "type": "string", "description": "Notes" }, "Label": { "type": "string", "description": "Label" }, "IsAzureBackup": { "type": "boolean", "description": "IsAzureBackup" }, "AzureStorageInformation": { "type": "string", "description": "AzureStorageInformation" } } } } } }, "summary": "Get instance backups", "operationId": "Get-Instance-Backups", "parameters": [ { "name": "instanceId", "in": "query", "required": true, "type": "string", "x-ms-summary": "Instance", "x-ms-dynamic-values": { "operationId": "Get-Instances", "value-path": "Id", "value-title": "FriendlyName" } } ], "description": "Retrieves all backups of a Customer Engagement instance." }, "post": { "responses": { "default": { "description": "default", "schema": { "type": "object", "properties": { "OperationId": { "type": "string", "description": "OperationId" }, "Status": { "type": "string", "description": "Status" }, "Errors": { "type": "array", "items": { "type": "string" }, "description": "Errors" }, "Information": { "type": "array", "items": { "type": "string" }, "description": "Information" }, "OperationLocation": { "type": "string", "description": "OperationLocation" }, "ResourceLocation": { "type": "string", "description": "ResourceLocation" }, "Context": { "type": "object", "properties": { "Items": { "type": "object", "properties": { "InstanceState": { "type": "string", "description": "InstanceState" } }, "description": "Items" } }, "description": "Context" } } } } }, "summary": "Backup instance", "operationId": "Backup-Instance", "parameters": [ { "name": "body", "in": "body", "required": false, "schema": { "type": "object", "properties": { "InstanceId": { "type": "string", "description": "InstanceId" }, "Label": { "type": "string", "description": "Label" }, "Notes": { "type": "string", "description": "Notes" } } } } ], "description": "Backs up a Customer Engagement instance." } }, "/Operation/{operationId}": { "get": { "responses": { "default": { "description": "default", "schema": { "type": "object", "properties": { "OperationId": { "type": "string", "description": "OperationId" }, "Status": { "type": "string", "description": "Status" }, "Errors": { "type": "array", "items": { "type": "string" }, "description": "Errors" }, "Information": { "type": "array", "items": { "type": "string" }, "description": "Information" }, "OperationLocation": { "type": "string", "description": "OperationLocation" }, "ResourceLocation": { "type": "string", "description": "ResourceLocation" }, "Context": { "type": "object", "properties": { "Items": { "type": "object", "properties": { "admin.InstanceId": { "type": "string", "description": "admin.InstanceId" } }, "description": "Items" } }, "description": "Context" } } } } }, "summary": "Get operation status", "operationId": "Get-Operation-Status", "parameters": [ { "name": "operationId", "in": "path", "required": true, "type": "string", "x-ms-summary": "Operation ID" } ], "description": "Retrieves status of an operation in your Customer Engagement instance." } }, "/Instances/{targetInstanceId}/Restore": { "post": { "responses": { "default": { "description": "default", "schema": { "type": "object", "properties": { "OperationId": { "type": "string", "description": "OperationId" }, "Status": { "type": "string", "description": "Status" }, "Errors": { "type": "array", "items": { "type": "string" }, "description": "Errors" }, "Information": { "type": "array", "items": { "type": "string" }, "description": "Information" }, "OperationLocation": { "type": "string", "description": "OperationLocation" }, "ResourceLocation": { "type": "string", "description": "ResourceLocation" }, "Context": { "type": "object", "properties": { "Items": { "type": "object", "properties": { "InstanceState": { "type": "string", "description": "InstanceState" } }, "description": "Items" } }, "description": "Context" } } } } }, "summary": "Restore instance", "operationId": "Restore-Instance", "parameters": [ { "name": "targetInstanceId", "in": "path", "required": true, "type": "string", "x-ms-dynamic-values": { "operationId": "Get-Instances", "value-path": "Id", "value-title": "FriendlyName" }, "x-ms-summary": "Target Instance" }, { "name": "body", "in": "body", "required": false, "schema": { "type": "object", "properties": { "SourceInstanceId": { "type": "string", "description": "Source Instance", "title": "", "x-ms-visibility": "", "x-ms-dynamic-values": { "operationId": "Get-Instances", "value-path": "Id", "value-title": "FriendlyName" } }, "Label": { "type": "string", "description": "Label" }, "CreatedOn": { "type": "string", "description": "Created On", "title": "", "x-ms-visibility": "" }, "InstanceBackupId": { "type": "string", "description": "Instance Backup Id", "title": "", "x-ms-visibility": "" } } } } ], "description": "Restores a Customer Engagement instance in your Office 365 tenant." } }, "/Instances/{InstanceId}/UpdateAdminMode": { "post": { "responses": { "default": { "description": "default", "schema": { "type": "object", "properties": { "OperationId": { "type": "string", "description": "OperationId" }, "Status": { "type": "string", "description": "Status" }, "Errors": { "type": "array", "items": { "type": "string" }, "description": "Errors" }, "Information": { "type": "array", "items": { "type": "string" }, "description": "Information" }, "OperationLocation": { "type": "string", "description": "OperationLocation" }, "ResourceLocation": { "type": "string", "description": "ResourceLocation" }, "Context": { "type": "object", "properties": { "Items": { "type": "object", "properties": { "InstanceState": { "type": "string", "description": "InstanceState" } }, "description": "Items" } }, "description": "Context" } } } } }, "summary": "Update Instance Admin Mode", "description": "Updates the Admin Mode settings of a Customer Engagement instance.", "operationId": "Update-Instance-Admin-Mode", "parameters": [ { "name": "InstanceId", "in": "path", "required": true, "type": "string", "x-ms-dynamic-values": { "operationId": "Get-Instances", "value-path": "Id", "value-title": "FriendlyName" } }, { "name": "body", "in": "body", "required": false, "schema": { "type": "object", "properties": { "AdminMode": { "type": "boolean", "description": "AdminMode" }, "BackgroundOperationsEnabled": { "type": "boolean", "description": "BackgroundOperationsEnabled" }, "NotificationText": { "type": "string", "description": "NotificationText" }, "OverrideUserObjectId": { "type": "string", "description": "OverrideUserObjectId" } } } } ] } } }, "definitions": {}, "parameters": {}, "responses": {}, "securityDefinitions": { "oauth2_auth": { "type": "oauth2", "flow": "accessCode", "authorizationUrl": "https://login.windows.net/common/oauth2/authorize", "tokenUrl": "https://login.windows.net/common/oauth2/authorize", "scopes": {} } }, "security": [ { "oauth2_auth": [] } ], "tags": [] }