Waiting for engine...
Skip to main content

environmentMigrationSettingsUpdate

Updates the environment settings and paths for an environment migration.

Input Parameters:

  • environmentId: ID of the environment migration to update.
  • restPath: REST API path configuration.
  • soapPath: SOAP API path configuration.
  • soap12Path: SOAP 1.2 API path configuration.
  • odataPath: OData API path configuration.
  • graphQLPath: GraphQL API path configuration.
  • configurationComplete: Boolean indicating whether settings configuration is completed.

Response:

  • Returns the EnvironmentMigration object with updated environment settings.

Example Request:

mutation environmentMigrationSettingsUpdate($environmentId: String!, $odataPath: String, $restPath: String, $soapPath: String, $soap12Path: String, $configurationComplete: Boolean) {
environmentMigrationSettingsUpdate(environmentId: $environmentId, odataPath: $odataPath, restPath: $restPath, soapPath: $soapPath, soap12Path: $soap12Path, configurationComplete: $configurationComplete) {
environment {
id,
name,
gateway {
id,
name,
deleted,
environments {
id,
name,
gateway {
id,
name,
deleted
},
settings {
restPath,
soapPath,
soap12Path,
odataPath
},
publishedName
},
defaultApiExecutionSettings {
concurrency,
retries,
retryCases,
connectTimeout,
executionTimeout
},
forwardProxy {
id,
enabled,
hostAddress,
portNumber,
proxyType,
username,
password
}
},
settings {
restPath,
soapPath,
soap12Path,
odataPath
},
publishedName
},
toGateway {
id,
name,
deleted,
environments {
id,
name,
publishedName
},
defaultApiExecutionSettings {
concurrency,
retries,
retryCases,
connectTimeout,
executionTimeout
},
forwardProxy {
id,
enabled,
hostAddress,
portNumber,
proxyType,
username,
password
}
},
fromGateway {
id,
name,
deleted,
environments {
id,
name,
publishedName
},
defaultApiExecutionSettings {
concurrency,
retries,
retryCases,
connectTimeout,
executionTimeout
},
forwardProxy {
id,
enabled,
hostAddress,
portNumber,
proxyType,
username,
password
}
},
environmentConfigurationCompleted,
containerConfigurationCompleted,
apiConfigurationCompleted,
gatewayConfigurationCompleted,
environmentSettings {
restPath,
soapPath,
soap12Path,
odataPath
},
warnings {
environmentWarnings {
entityIds,
errorCode,
message,
severity
},
containerWarnings {
entityIds,
errorCode,
message,
severity
},
apiWarnings {
entityIds,
errorCode,
message,
severity
}
}
}
}

**Variables:**

```json
{
"environmentId": "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>",
"odataPath": "api/odata/v1",
"restPath": "api/rest/v1",
"soapPath": "api/soap/v1",
"soap12Path": "api/soap12/v1",
"configurationComplete": true
}

environmentMigrationSettingsUpdate(
environmentId: String!
odataPath: String
restPath: String
soapPath: String
soap12Path: String
graphQLPath: String
configurationComplete: Boolean
): EnvironmentMigration

Arguments

environmentMigrationSettingsUpdate.environmentId ● String! non-null scalar miscellaneous

environmentMigrationSettingsUpdate.odataPath ● String scalar miscellaneous

environmentMigrationSettingsUpdate.restPath ● String scalar miscellaneous

environmentMigrationSettingsUpdate.soapPath ● String scalar miscellaneous

environmentMigrationSettingsUpdate.soap12Path ● String scalar miscellaneous

environmentMigrationSettingsUpdate.graphQLPath ● String scalar miscellaneous

environmentMigrationSettingsUpdate.configurationComplete ● Boolean scalar miscellaneous

Type

EnvironmentMigration object platform

Represents the migration process of an environment from one gateway to another with configuration status tracking.

On this Page