POST api/v2/electrical/projects/distributionboards/create

CreateElectricalProjectDistributionBoard

Request Information

URI Parameters

None.

Body Parameters

The command

CreateElectricalProjectDistributionBoardCommand

Name	Type	Additional information
ElectricalProjectDistributionBoardId	universally unique identifier	None.
ElectricalProjectVersionId	universally unique identifier	Required
Kind	ElectricalProjectDistributionBoardKind	None.
Order	integer (32 bits)	None.
Identifier	string	Max length: 100
ReportImages	boolean	None.
ReportThermalImages	boolean	None.
ReportCurrentMeasurements	boolean	None.
ReportVoltageMeasurements	boolean	None.
ReportGroundImpedanceMeasurements	boolean	None.
ReportNeutralImpedanceMeasurements	boolean	None.
ReportResidualCurrentDevices	boolean	None.
ReportResidualCurrentCircuitBreakerDevices	boolean	None.
ReportFinalCircuitProtectiveDevices	boolean	None.
ReportIsolationResistanceMeasurements	boolean	None.
ReportCheckListItems	boolean	None.
SkipCreateCheckListItems	boolean	None.

Request Formats

application/json

Sample:

{
  "ElectricalProjectDistributionBoardId": "00000000-0000-0000-0000-000000000000",
  "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
  "Kind": "MainDistributionBoard",
  "Order": 1,
  "Identifier": "sample string 1",
  "ReportImages": true,
  "ReportThermalImages": true,
  "ReportCurrentMeasurements": true,
  "ReportVoltageMeasurements": true,
  "ReportGroundImpedanceMeasurements": true,
  "ReportNeutralImpedanceMeasurements": true,
  "ReportResidualCurrentDevices": true,
  "ReportResidualCurrentCircuitBreakerDevices": true,
  "ReportFinalCircuitProtectiveDevices": true,
  "ReportIsolationResistanceMeasurements": true,
  "ReportCheckListItems": true,
  "SkipCreateCheckListItems": true
}

Response Information

Resource Description

CreateElectricalProjectDistributionBoardCommandResult

Name	Description	Type	Additional information
Result		CreateElectricalProjectDistributionBoardCommandResultKind	Required
ElectricalProjectDistributionBoardId		universally unique identifier	Required

Response Formats

application/json

Sample:

{
  "Result": "Success",
  "ElectricalProjectDistributionBoardId": "00000000-0000-0000-0000-000000000000"
}