The List Specific Environment call returns a JSON object representing the specified Environment.


Query:


http://host/dmadminweb/API/Environment/identifier


Where:


Host

Is the hostname and port of the DeployHub Server (e.g.: hostname:8080 or for SaaS console.deployhub.com).

Identifier

Is the identifier of the Environment. Either its name, its qualified name (i.e.: with its parent domain(s) included in dot notation) or its internal ID.


Example Result:


{

       "success": true,

       "result": {

               "domain": "FIS.Dev",

               "id": 16,

               "name": "DevEnv1",

               "owneruser": "admin",

               "summary": "",

               "Applications": [

                       {

                               "completed": "",

                               "deploymentid": 1069,

                               "exitcode": 0,

                               "id": 161,

                               "name": "FISApp",

                               "predecessorid": 163,

                               "versionid": 164,

                               "versionname": "FISApp;3"

                       }

                       Repeated for each Application in the Environment

               ]

       }

}


success:

Is true or false depending on the success or failure of the query. If success is false, then result is not returned, and a text field named “error” is returned instead.

result:

Is a JSON object containing the details of the requested Environment.


Within the “result” Object:


Applications:

Is an array of objects, one for each Application associated with the Environment.

Domain:

The fully-qualified Domain name of the domain in which the Environment is located.

Id:

Is the internal ID of the Environment.

Name:

Is the name of the Environment.

owneruser:

If the “owner” of the Environment is a user, then this is the name of the User.

ownergroup:

If the “owner” of the Environment is a User Group, then this is the name of that Group.

Summary:

The summary string associated with the Environment.



Within each Application Object:


deploymentid:

The ID of the last deployment of this Application into the Environment. An ID of 0 indicates that the Application has been manually associated with the Environment.

exitcode:

The exit code of the last deployment of this Application into the Environment.

Id:

The internal object ID of the Application Base Version.

name:

The name of the Application Base Version.

predecessorid:

The ID of the previous Application version if the Application is a Version.

completed:

The date/time of the last deployment of this Application into the Environment.

versionname:

The name of the Application version if the Application is a Version.

versionid:

The ID of the Application version if the Application is a Version.