GET api/v2/environments/list
List environment
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | StringExpressionQueryFilterList |
None. |
|
| Description | StringExpressionQueryFilterList |
None. |
|
| ApplicationName | StringExpressionQueryFilterList |
None. |
|
| AreaKind | RelationalExpressionQueryFilterListOfNullableOfAreaKind |
None. |
|
| Url | StringExpressionQueryFilterList |
None. |
|
| ApiUrl | StringExpressionQueryFilterList |
None. |
|
| Select | ListEnvironmentQuerySelect |
Required |
|
| Sort | Collection of ListEnvironmentQuerySort |
Required |
|
| PageNumber | integer (32 bits) |
Required |
|
| PageSize | integer (32 bits) |
Required |
Body Parameters
None.
Response Information
Resource Description
The list environment query result
ListEnvironmentQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Environments | Collection of ListEnvironmentQueryResultEnvironment |
Required |
|
| Count | integer (32 bits) |
Range: inclusive between 0 and 2147483647 |
Response Formats
application/json
Sample:
{
"Environments": [
{
"EnvironmentId": "8a9e3615-9d9d-04e9-1536-9e8a9d9de904",
"Name": "sample string 1",
"Description": "sample string 2",
"ApplicationName": "sample string 3",
"AreaKind": "Default",
"Url": "sample string 4",
"ApiUrl": "sample string 5",
"EnvironmentLogins": [
{
"LoginName": "sample string 1",
"Number": 1
},
{
"LoginName": "sample string 1",
"Number": 1
}
]
},
{
"EnvironmentId": "8a9e3615-9d9d-04e9-1536-9e8a9d9de904",
"Name": "sample string 1",
"Description": "sample string 2",
"ApplicationName": "sample string 3",
"AreaKind": "Default",
"Url": "sample string 4",
"ApiUrl": "sample string 5",
"EnvironmentLogins": [
{
"LoginName": "sample string 1",
"Number": 1
},
{
"LoginName": "sample string 1",
"Number": 1
}
]
}
],
"Count": 1
}