通过

Environment Restore - Get Restore Candidates

Service:
Power Platform API
API Version:
2022-03-01-preview

Gets the list of restore candidates when restore from the specified environment (Preview).

GET https://api.powerplatform.com/environmentmanagement/environments/{sourceEnvironmentId}/restoreCandidates?api-version=2022-03-01-preview
With optional parameters: 
GET https://api.powerplatform.com/environmentmanagement/environments/{sourceEnvironmentId}/restoreCandidates?ValidateOnly={ValidateOnly}&ValidateProperties={ValidateProperties}&api-version=2022-03-01-preview

URI Parameters

Name In Required Type Description
sourceEnvironmentId
 path True

string

The environment ID of restore from.
api-version
 query True

string

The API version.
ValidateOnly
 query

boolean

The value which indicates whether the operation is a validated only request. Examples:

validateOnly=true with validateProperties non-empty: Validate only the listed properties, ignoring others even if present in the body.

validateOnly=true with empty/absent validateProperties: Validate the entire body (equivalent to full validation).

validateOnly=false or omitted: Process the full request(validate and execute).
ValidateProperties
 query

string

The value which indicates what properties should be validated. Need to work together with ValidateOnly. Properties should be separated by ','. Example: "property1,property2,property3".

Responses

Name Type Description
200 OK

EnvironmentPagedCollection

OK

Media Types: "text/plain", "application/json", "text/json"
400 Bad Request

ValidationResponse

Bad Request

Media Types: "text/plain", "application/json", "text/json"
404 Not Found

ValidationResponse

Not Found

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

Security

oauth2

Microsoft Entra ID OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=https://api.powerplatform.com

Scopes

Name Description
.default .default

Definitions

Name Description
Environment

Power platform Environment
EnvironmentPagedCollection
ErrorInfo

Represents error information for an operation.
ValidationResponse

Represents the response for validation of an operation.

Environment

Object

Power platform Environment

Name Type Description
dataverseOrganizationUrl

string

Dataverse organization URL of the environment.
displayName

string

Display name of the environment.
environmentId

string

The environment ID.

EnvironmentPagedCollection

Object
Name Type Description
collection

Environment[]

Power platform Environment
continuationToken

string

ErrorInfo

Object

Represents error information for an operation.

Name Type Description
code

string

The error Code.
fieldErrors

object

The detailed error.

ValidationResponse

Object

Represents the response for validation of an operation.

Name Type Description
errorDetail

ErrorInfo

Represents error information for an operation.