PATCH api/v2/electrical/projects/observations/patch
PatchElectricalProjectObservation
Request Information
URI Parameters
None.
Body Parameters
The command
PatchElectricalProjectObservationCommand| Name | Description | Type | Additional information |
|---|---|---|---|
| ElectricalProjectObservationId | universally unique identifier |
Required |
|
| ClearFields | Collection of PatchElectricalProjectObservationCommandClearField |
None. |
|
| Order | integer (32 bits) |
None. |
|
| FloorplanElectricalProjectFileId | universally unique identifier |
None. |
|
| FloorplanPinCoordinateX | integer (32 bits) |
Range: inclusive between 0 and 1000 |
|
| FloorplanPinCoordinateY | integer (32 bits) |
Range: inclusive between 0 and 1000 |
|
| LocationRemark | string |
Max length: 100 |
|
| Remark | string |
Max length: 1000 |
|
| Recommendation | string |
Max length: 1000 |
|
| ElectricalObservationClassificationGroupId | universally unique identifier |
None. |
|
| ElectricalObservationClassificationCodeId | universally unique identifier |
None. |
|
| CodeKind | ElectricalObservationClassificationCodeKind |
None. |
Request Formats
application/json
Sample:
{
"ElectricalProjectObservationId": "00000000-0000-0000-0000-000000000000",
"ClearFields": [
"FloorplanElectricalProjectFileId",
"FloorplanElectricalProjectFileId"
],
"Order": 1,
"FloorplanElectricalProjectFileId": "00000000-0000-0000-0000-000000000000",
"FloorplanPinCoordinateX": 1,
"FloorplanPinCoordinateY": 1,
"LocationRemark": "sample string 1",
"Remark": "sample string 2",
"Recommendation": "sample string 3",
"ElectricalObservationClassificationGroupId": "00000000-0000-0000-0000-000000000000",
"ElectricalObservationClassificationCodeId": "00000000-0000-0000-0000-000000000000",
"CodeKind": "Severe"
}
Response Information
Resource Description
PatchElectricalProjectObservationCommandResult
PatchElectricalProjectObservationCommandResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | PatchElectricalProjectObservationCommandResultKind |
Required |
Response Formats
application/json
Sample:
{
"Result": "Success"
}