PATCH api/v2/electrical/projects/finalcircuits/patch

PatchElectricalProjectFinalCircuit

Request Information

URI Parameters

None.

Body Parameters

The command

PatchElectricalProjectFinalCircuitCommand

Name	Type	Additional information
ElectricalProjectFinalCircuitId	universally unique identifier	Required
ClearFields	Collection of PatchElectricalProjectFinalCircuitCommandClearField	None.
Kind	ElectricalProjectFinalCircuitKind	None.
Identifier	string	Max length: 100
Order	integer (32 bits)	None.
FloorNumber	string	Max length: 50
SpaceNumber	string	Max length: 50
InternalRemark	string	Max length: 500
InternalImageRemark	string	Max length: 500
InternalThermalImageRemark	string	Max length: 500
ElectricalProjectDistributionBoardId	universally unique identifier	None.
ReportImages	boolean	None.
ReportThermalImages	boolean	None.
ReportCheckListItems	boolean	None.

Request Formats

application/json

Sample:

{
  "ElectricalProjectFinalCircuitId": "00000000-0000-0000-0000-000000000000",
  "ClearFields": [
    "Kind",
    "Kind"
  ],
  "Kind": "FinalCircuit",
  "Identifier": "sample string 1",
  "Order": 1,
  "FloorNumber": "sample string 2",
  "SpaceNumber": "sample string 3",
  "InternalRemark": "sample string 4",
  "InternalImageRemark": "sample string 5",
  "InternalThermalImageRemark": "sample string 6",
  "ElectricalProjectDistributionBoardId": "00000000-0000-0000-0000-000000000000",
  "ReportImages": true,
  "ReportThermalImages": true,
  "ReportCheckListItems": true
}

Response Information

Resource Description

PatchElectricalProjectFinalCircuitCommandResult

Name	Description	Type	Additional information
Result		PatchElectricalProjectFinalCircuitCommandResultKind	Required

Response Formats

application/json

Sample:

{
  "Result": "Success"
}