BazeField Services

ObjectStructureGetRequest

Core API

The following routes are available for this service:
GET, POST	/api/objects/structure	Get objects filtered by type

**ObjectStructureGetRequest** Parameters:
Name	Parameter	Data Type	Required	Description
type	body	int?	No	Object type as in 200 being Wind Turbine, 243 being Turbine String, etc.
attributes	body	List<string>	No	Specify attributes to be included in the response
ClientRequestHandle	body	string	No

**ObjectStructureGetResponse** Parameters:
Name	Parameter	Data Type	Required	Description
data	form	List<DomainObject>	No

**BazefieldResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ReplyInfo	form	ReplyInfo	No

**ReplyInfo** Parameters:
Name	Parameter	Data Type	Required
RcvTime	form	double	No
ReplyTime	form	double	No
ClientRequestHandle	form	string	No
Error	form	string	No

**DomainObject** Parameters:
Name	Parameter	Data Type	Required	Description
ObjectId	form	string	No
mdmid	form	string	No

**DomainObjectAttributes** Parameters:
Name	Parameter	Data Type	Required	Description
Attributes	form	Dictionary<string, string>	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/objects/structure HTTP/1.1 
Host: mdn.bazefield.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	type: 0,
	attributes: 
	[
		String
	],
	clientRequestHandle: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	data: 
	[
		{
			objectId: String,
			mdmid: String,
			attributes: 
			{
				String: String
			}
		}
	],
	replyInfo: 
	{
		rcvTime: 0,
		replyTime: 0,
		clientRequestHandle: String,
		error: String
	}
}