POST | /api/objectTypes/createOrUpdateObjectType | Create or Update object type |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PkId | body | int | No | |
TypeId | body | int | No | |
CategoryId | body | int | No | |
Name | body | string | No | |
ClassId | body | int | No | |
Attributes | body | List<DomainObjectTypeAttribute> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Value | form | Object | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Key | form | string | No | |
Name | form | string | No | |
DisplayId | form | int? | No | |
IsMandatory | form | bool? | No | |
ValueType | form | int? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | BazefieldObjectType | No | |
Name | form | string | No | |
Attributes | form | List<DomainObjectTypeAttribute> | No | |
IsSubAsset | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CoreType | form | string | No | |
TypeId | form | int | No | |
CategoryId | form | int | No | |
ClassId | form | int | No | |
Key | form | string | No | |
MajorType | form | MajorTypeEnum | No | |
ObjectClass | form | ObjectClassEnum | No | |
Category | form | CategoryEnum | No |
Name | Value | |
---|---|---|
Bazefield | 2 | |
System | 54 | |
Partner | 55 | |
Customer | 56 | |
SiteGroup | 57 | |
Site | 58 | |
Project | 102 | |
Device | 200 |
Name | Value | |
---|---|---|
Bazefield | 20020 | |
Partner | 20550 | |
Customer | 20560 | |
SiteGroup | 20570 | |
PhysicalSite | 20580 | |
Windfarm | 211020 | |
WindTurbine | 212000 | |
MetMast | 212010 | |
TurbineString | 212430 | |
Custom | 212580 | |
Solarfarm | 221020 | |
Inverter | 222060 | |
InverterStation | 222330 | |
InverterWeatherStation | 223300 | |
PVPlantWeatherStation | 223350 | |
SubstationSite | 281020 | |
PrimarySubstation | 282320 | |
Meter | 283010 | |
TransmissionLine | 283020 | |
Circuit | 283030 | |
UnitSubstation | 283040 | |
Feeder | 283100 | |
PowerPlantController | 283150 | |
Transformer | 283200 | |
Capacitor | 283250 | |
HydropowerSite | 601020 | |
HydroGenerator | 602260 | |
NotDefined | -1 |
Name | Value | |
---|---|---|
Fleet | 2 | |
Wind | 21 | |
Solar | 22 | |
Substation | 28 | |
Hydro | 60 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/objectTypes/createOrUpdateObjectType HTTP/1.1
Host: mdn.bazefield.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"pkId":0,"typeId":0,"categoryId":0,"name":"String","classId":0,"attributes":[{"value":{},"key":"String","name":"String","displayId":0,"isMandatory":false,"valueType":0}]}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"name":"String","attributes":[{"value":{},"key":"String","name":"String","displayId":0,"isMandatory":false,"valueType":0}],"isSubAsset":false}