Environment APIs

Get a list of Environments.

List Environments

Description

This call returns an array of JSON objects representing each Environment to which the logged-in User has access.

If the all parameter is not specified then only the Environments associated with the User’s home Domain are listed. If the all parameter is specified and is set to “y”, for yes, then the result includes the Environments included in any accessible Subdomains.

REST Api Endpoint

HTTP Verb URL
GET /dmadminweb/API/environments

Parameters

Name Located in Description Required Schema
all query y or n No string

Environments Result

Name Type Description Required
success boolean 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. No
result An Array of Environments Is a JSON array of objects, one for each Environment returned by the query (if success is true). No

Environment Object

Name Type Description Required
domain string The fully-qualified Domain Name of the Domain in which the Environment is located. No
id integer Is the internal ID of the Environment. No
name string Is the name of the Environment. No
owneruser string If the “owner” of the Environment is a User, then this is the name of the User. No
ownergroup string If the “owner” of the Environment is a Group, then this is the name of that Group. No
summary string The summary string associated with the environment. No
applications An Application Object The Application. No

Retrieve specific Environment

This call returns a JSON object representing the specified Environment.

REST Api Endpoint

HTTP Verb URL
GET /dmadminweb/API/environment/{identifier}

Parameters

Name Located in Description Required Schema
identifier path Is the identifier of the Environment. Either its name, its qualified name with its parent Domains included in dot notations (i.e. GLOBAL.Product) or its internal ID. Yes string

Response Success Object

This Object contains the success/failed return code and an error message.

Name Type Boolean Description Required
success boolean Success or Failure. Yes
error string Error message returned from API. No

Environments Result

Name Type Description Required
success boolean 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. No
result An Array of Environments Is a JSON array of objects, one for each Environment returned by the query (if success is true). No
Last modified June 22, 2020: final on Apps and Components (6fc14b5)