environmentUpdate

Updates various fields of the Environment. If a specific error occurs, the errorCode will be one of the EnvironmentErrorCode values.

Input Parameters:

• environment: Environment configuration object including ID and settings to update.

Response:

• Returns the updated Environment object with modified configuration settings.

Example Request:

mutation {
    environmentUpdate(environment: {
        id: "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>",
        settings: {
            restPath: "api/rest/v1",
            soapPath: "api/soap/v1",
            soap12Path: "api/soap12/v1",
            odataPath: "api/odata/v1",
            graphQLPath: "api/graphql/v1"
        }
    }) {
        id,
        name,
        gateway {
            id,
            name,
            deleted,
            externalUrl,
            externalHealthCheckPath,
            gatewayType,
            version,
            internalSslEnabled
        },
        settings {
            restPath,
            soapPath,
            soap12Path,
            odataPath,
            graphQLPath
        },
        publishedName,
        classification,
        integrationPackEnvironmentAttachment {
            id,
            integrationPackInstanceId,
            environmentId
        },
        atoms {
            id,
            name,
            authType,
            webserviceType,
            status,
            type,
            effectiveHostName
        }
    }
}

environmentUpdate(
  environment: EnvironmentInput
): Environment

Arguments

environmentUpdate.environment ● EnvironmentInput input platform

Type

Environment object event-streams-query