Instances - Update Instance Admin Mode

Service:

Online Management API Reference

API Version:

v1.4

Updates the Admin Mode settings of a Dataverse environment. This API is deprecated.
For a list of region-specific service URLs, see Service URL

POST {ServiceUrl}/api/v1.2/Instances/{id}/UpdateAdminMode

With optional parameters:

POST {ServiceUrl}/api/v1.2/Instances/{id}/UpdateAdminMode?validate={validate}

URI Parameters

Name	In	Required	Type	Description
id	path	True	string uuid	ID of the Dataverse environment to update the admin mode settings.
validate	query		boolean	Indicates whether to validate or update an instance. Set True to validate; set False to update.

Request Body

Media Types: "application/json", "text/json"

Name	Type	Description
AdminMode	boolean	Indicates whether to enable or disable the Admin Mode settings.
BackgroundOperationsEnabled	boolean	Indicates whether to enable or disable the background operations.
NotificationText	string
OverrideUserObjectId	string	If set, will be used instead of the UserObjectID of the calling user.

Responses

Name	Type	Description
200 OK	OperationStatus	Update Instance Admin Mode Operation Executed. Media Types: "application/json", "text/json"
400 Bad Request	OperationStatus	There was an issue either validating or executing the update admin mode update operation. Media Types: "application/json", "text/json"
404 Not Found		NotFound Media Types: "application/json", "text/json"

Definitions

Name	Description
InstanceAdminModeSettings
ItemDescription	Set of values to define an error or information item
OperationContext	The operation context object
OperationState	State of the operation
OperationStatus	Status of the operation

InstanceAdminModeSettings

Name	Type	Description
AdminMode	boolean	Indicates whether to enable or disable the Admin Mode settings.
BackgroundOperationsEnabled	boolean	Indicates whether to enable or disable the background operations.
NotificationText	string
OverrideUserObjectId	string	If set, will be used instead of the UserObjectID of the calling user.

ItemDescription

Set of values to define an error or information item

Name	Type	Description
Code	string	Code of the item
Description	string	Description of the item
Subject	string	Subject of the item

OperationContext

The operation context object

Name	Type	Description
Items	object	The item object

OperationState

State of the operation

Name	Type	Description
Aborted	string
Aborting	string
Cancelled	string
Cancelling	string
Conflict	string
Deleted	string
Deleting	string
Failed	string
FailedToCreate	string
None	string
NotFound	string
NotStarted	string
Pending	string
Ready	string
Running	string
Succeeded	string
Tombstone	string

OperationStatus

Status of the operation

Name	Type	Description
Context	OperationContext	The operation context object
Errors	ItemDescription[]	Set of values to display errors during an operation
Information	ItemDescription[]	Set of values to display information during an operation
OperationId	string	ID of the operation
OperationLocation	string	Location of the operation
ResourceLocation	string	Location of the resource
Status	OperationState	State of the operation