POST api/v2/electrical/projects/finalcircuits/create
CreateElectricalProjectFinalCircuit
Request Information
URI Parameters
None.
Body Parameters
The command
CreateElectricalProjectFinalCircuitCommand| Name | Description | Type | Additional information |
|---|---|---|---|
| ElectricalProjectFinalCircuitId | universally unique identifier |
None. |
|
| ElectricalProjectVersionId | universally unique identifier |
Required |
|
| Kind | ElectricalProjectFinalCircuitKind |
None. |
|
| Identifier | string |
Max length: 100 |
|
| Order | integer (32 bits) |
None. |
|
| FloorNumber | string |
Max length: 50 |
|
| SpaceNumber | string |
Max length: 50 |
|
| ElectricalProjectDistributionBoardId | universally unique identifier |
None. |
|
| SkipCreateCheckListItems | boolean |
None. |
Request Formats
application/json
Sample:
{
"ElectricalProjectFinalCircuitId": "00000000-0000-0000-0000-000000000000",
"ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
"Kind": "FinalCircuit",
"Identifier": "sample string 1",
"Order": 1,
"FloorNumber": "sample string 2",
"SpaceNumber": "sample string 3",
"ElectricalProjectDistributionBoardId": "00000000-0000-0000-0000-000000000000",
"SkipCreateCheckListItems": true
}
Response Information
Resource Description
CreateElectricalProjectFinalCircuitCommandResult
CreateElectricalProjectFinalCircuitCommandResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | CreateElectricalProjectFinalCircuitCommandResultKind |
Required |
|
| ElectricalProjectFinalCircuitId | universally unique identifier |
Required |
Response Formats
application/json
Sample:
{
"Result": "Success",
"ElectricalProjectFinalCircuitId": "00000000-0000-0000-0000-000000000000"
}