BazeField Services

ObjectTypeCreateOrUpdateRequest

Core API

The following routes are available for this service:
POST	/api/objectTypes/createOrUpdateObjectType	Create or Update object type

**ObjectTypeCreateOrUpdateRequest** Parameters:
Name	Parameter	Data Type	Required
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

**DomainObjectTypeAttribute** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	Object	No

**DomainObjectTypeAttributeBase** Parameters:
Name	Parameter	Data Type	Required
Key	form	string	No
Name	form	string	No
DisplayId	form	int?	No
IsMandatory	form	bool?	No
ValueType	form	int?	No

**DomainObjectType** Parameters:
Name	Parameter	Data Type	Required
Type	form	BazefieldObjectType	No
Name	form	string	No
Attributes	form	List<DomainObjectTypeAttribute>	No
IsSubAsset	form	bool	No

**BazefieldObjectType** Parameters:
Name	Parameter	Data Type	Required
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

**MajorTypeEnum** Enum:
Name	Value
Bazefield	2
System	54
Partner	55
Customer	56
SiteGroup	57
Site	58
Project	102
Device	200

**ObjectClassEnum** Enum:
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

**CategoryEnum** Enum:
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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ObjectTypeCreateOrUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bazefield.Core.WebService.Request">
  <Attributes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bazefield.Domain.DataModel.Entities">
    <d2p1:DomainObjectTypeAttribute>
      <d2p1:DisplayId>0</d2p1:DisplayId>
      <d2p1:IsMandatory>false</d2p1:IsMandatory>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:ValueType>0</d2p1:ValueType>
      <d2p1:Value />
    </d2p1:DomainObjectTypeAttribute>
  </Attributes>
  <CategoryId>0</CategoryId>
  <ClassId>0</ClassId>
  <Name>String</Name>
  <PkId>0</PkId>
  <TypeId>0</TypeId>
</ObjectTypeCreateOrUpdateRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DomainObjectType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bazefield.Domain.DataModel.Entities" />