Sign in
Test Environments

Retrieve a test environment response

Use this operation to retrieves a specific Test Environment by its unique identifier. It returns a TestEnvironmentResponse object if the environment is found. If the specified Test Environment does not exist, it returns a 404 error.

User Access Permission

You must be assigned the Refresh Central Sandbox permission to run this operation.

get/test-environments/{id}

Path parameters

idstring required

Test Environment ID

Headers

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Response

Successfully retrieved Test Environment response

createTimestring date-time

The date and time when the Test Environment was first synced to self-service

createdByIdstring

The automatically generated ID of the Zuora user who created the Test Environment object

dataCopyType'FULL' | 'CONFIGURATION'

The data copy approach for the Test Environment

deactivationTimestring date-time

The date and time when the Test Environment will be deactivated

environmentType'TEST' | 'ENTERPRISE' | 'TRIAL' | 'DEMO' | 'DEVELOPER'

The type of tenant for the Test Environment

idstring

The unique ID (UUID) of the Test Environment

lastRefreshTimestring date-time

The date and time when the Test Environment was last refreshed

nextRefreshTimestring date-time

The date and time when the Test Environment can be refreshed again

provisionTimestring date-time

The date and time when the Test Environment was provisioned

revenueTenantIdstring

The revenue tenant ID if a revenue sandbox is attached

revenueTenantNamestring

The revenue tenant name if a revenue sandbox is attached

sourceTenantIdstring

The source tenant ID from which the Test Environment was created

status'ACTIVE' | 'PROCESSING' | 'INACTIVE' | 'DEACTIVATED' | 'DELETED'

The current status of the Test Environment

tenantIdstring

The tenant ID of the Test Environment

tenantNamestring

The tenant name of the Test Environment

updateTimestring date-time

The date and time when the Test Environment was last synced to self-service

updatedByIdstring

The automatically generated ID of the Zuora user who updated the Test Environment object

Example response

{
  "createdById": "58f182ab203c447b8b9cd90382da030a",
  "environmentType": "ENTERPRISE",
  "id": "11111111-1111-1111-1111-111111111111",
  "status": "ACTIVE",
  "updatedById": "58f182ab203c447b8b9cd90382da030a"
}

Changes