Environment API
{ http://soa.com/wsdl/environment/1.0 } EnvironmentAPI
The Environment service provides operations for finding information about the configured environments.
GET/environmentsgetEnvironments
Returns environments within the given scope. The scopes are "global" (all environments),
"local" (only those defined in the local system/tenant), and "default" (default local
environment). The scope parameter is optional, the default value is "global".
Request:
GET /environments?Scope=local HTTP/1.1
Accept: application/json
Response:
HTTP/1.1 200 OK
{
"Environment" : [ {
"Name" : "Development",
"CurrentEnvironment" : true
}, {
"Name" : "QA",
"CurrentEnvironment" : false
}, {
"Name" : "Staging",
"CurrentEnvironment" : false
} ]
}
Parameters
Name
Type
Description
Model
Scope
query
Scope of the results, global, local, default. Optional, if not supplied the default is global.
string
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v84+jsonapplication/vnd.soa.v84+xml
200
Success
Environments
Environments {
Environment( Collection of Environment )
}
Environment {
Description( string )
DisplayName( string )
CurrentEnvironment( boolean )
Name( string )
}