Retrieving an Environment

Use Get Environment to retrieve a list of all environments and then use one of those environments to create a system.

URL:

http://servername:8089/do?

The input parameters are listed in the following table:

Parameters

Type

Value

Mandatory

Comment

action

Stringt

env

Y

 

subaction

String

getenvlist

Y

 

idenv

String

 

N

If looking for single environment then pass this value.

An example of input would be:

Type

Input

action

environment

subaction

getenvlist

The responses are listed in the following table:

Response

Type

Comment

totalcount

int

Returns the total number of environments that currently exist. Not returned when idenv is passed.

env

Node

This is the node under which all the Env will follow.

name

String

Name of the environment. This comes as child of env node when idenv is not passed.

description

String

Description of the environment. This comes as child of envnode when idenv is not passed.

A sample of a JSON response when idenv is not passed follows:

{
"totalcount":3,
"env":[
{"updatedt":"2009-08-21 14:19:54.0","description":"This is used for DEV testing","name":"Dev0","idenvironment":4,"updateuser":"admin"},
{"updatedt":null,"description":"","name":"QA","idenvironment":2,"updateuser":null},
{"updatedt":null,"description":"","name":"Production","idenvironment":1,"updateuser":null}
]
}

A sample of a JSON response when idenv is passed follows:

Type

Input

action

env

idenv

1

subaction

getenvlist

[{"updatedt":null,"description":"","name":"Production","idenvironment":1,"updateuser":null}]

iWay Software