PUT api/v2/objects/edit
EditObject
Request Information
URI Parameters
None.
Body Parameters
The command
EditObjectCommand| Name | Description | Type | Additional information |
|---|---|---|---|
| ObjectId | universally unique identifier |
Required |
|
| Name | string |
Max length: 100 |
|
| Description | string |
Max length: 250 |
|
| string |
Data type: EmailAddress Max length: 256 |
||
| TelephoneNumber | string |
Max length: 60 |
|
| TotalFloorArea | integer (32 bits) |
Range: inclusive between 0 and 1000000 |
|
| ConstructionYear | integer (32 bits) |
Range: inclusive between 1000 and 2100 |
|
| Remarks | string |
Max length: 1000 |
Request Formats
application/json
Sample:
{
"ObjectId": "00000000-0000-0000-0000-000000000000",
"Name": "sample string 1",
"Description": "sample string 2",
"Email": "sample string 3",
"TelephoneNumber": "sample string 4",
"TotalFloorArea": 1,
"ConstructionYear": 1,
"Remarks": "sample string 5"
}
Response Information
Resource Description
EditObjectCommandResult
EditObjectCommandResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | EditObjectCommandResultKind |
Required |
Response Formats
application/json
Sample:
{
"Result": "Success"
}