GET api/cleanroomapi/cleanrooms?active={active}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| active | boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of CleanRoomViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| active | boolean |
Required |
|
| cleanroom_type_id | globally unique identifier |
Required |
|
| communication_server_id | globally unique identifier |
Required |
|
| id | globally unique identifier |
None. |
|
| local_id | integer |
Range: inclusive between 0 and ∞ |
|
| local_name | string |
None. |
|
| name | string |
Required |
|
| type_of_temperature | string |
Required |
Response Formats
application/json, text/json
Sample:
[
{
"active": true,
"cleanroom_type_id": "ee15bfeb-3140-487b-be38-2dfcd8f923d2",
"communication_server_id": "73d63002-4d68-4120-8b64-bb4c6dd5a5a8",
"id": "8c13a920-4a5e-4b7a-86e7-c5bbb531cb4d",
"local_id": 1,
"local_name": "sample string 3",
"name": "sample string 4",
"type_of_temperature": "sample string 5"
},
{
"active": true,
"cleanroom_type_id": "ee15bfeb-3140-487b-be38-2dfcd8f923d2",
"communication_server_id": "73d63002-4d68-4120-8b64-bb4c6dd5a5a8",
"id": "8c13a920-4a5e-4b7a-86e7-c5bbb531cb4d",
"local_id": 1,
"local_name": "sample string 3",
"name": "sample string 4",
"type_of_temperature": "sample string 5"
}
]
application/xml, text/xml
Sample:
<ArrayOfcleanroom xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel">
<cleanroom>
<active>true</active>
<cleanroom_type_id>ee15bfeb-3140-487b-be38-2dfcd8f923d2</cleanroom_type_id>
<communication_server_id>73d63002-4d68-4120-8b64-bb4c6dd5a5a8</communication_server_id>
<id>8c13a920-4a5e-4b7a-86e7-c5bbb531cb4d</id>
<local_id>1</local_id>
<local_name>sample string 3</local_name>
<name>sample string 4</name>
<type_of_temperature>sample string 5</type_of_temperature>
</cleanroom>
<cleanroom>
<active>true</active>
<cleanroom_type_id>ee15bfeb-3140-487b-be38-2dfcd8f923d2</cleanroom_type_id>
<communication_server_id>73d63002-4d68-4120-8b64-bb4c6dd5a5a8</communication_server_id>
<id>8c13a920-4a5e-4b7a-86e7-c5bbb531cb4d</id>
<local_id>1</local_id>
<local_name>sample string 3</local_name>
<name>sample string 4</name>
<type_of_temperature>sample string 5</type_of_temperature>
</cleanroom>
</ArrayOfcleanroom>