BazeField Services

CommentsCreateRequest

Comment API

Create one or more comments for an asset or an alarm/allocation for an asset.

The following routes are available for this service:
POST	/api/comments

**CommentsCreateRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Comments	body	List<Comment>	No

**Comment** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
TurbineId	form	int	No
TurbineName	form	string	No
TimeStamp	form	DateTime	No
Text	form	string	No
CreatedBy	form	string	No
CreatedById	form	decimal?	No
LastModified	form	DateTime	No
Type	form	CommentType	No
External	form	bool?	No
Sticky	form	bool?	No
AllocationId	form	int?	No
AlarmLogId	form	int?	No
AlarmId	form	int?	No
CommandId	form	int?	No
RelatedInfo	form	string	No
Cleared	form	bool	No
Labels	form	List<Label>	No
ObjectId	form	string	No
RelatedStart	form	DateTime?	No
RelatedEnd	form	DateTime?	No

**CommentType** Enum:
Turbine
Allocation
Alarm

**Label** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Color	form	string	No
Type	form	LabelType?	No

**LabelType** Enum:
Name	Value
Allocation	1
Other	2

**CommentsCreateResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Comments	form	List<Comment>	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/comments HTTP/1.1 
Host: mdn.bazefield.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	comments: 
	[
		{
			id: 0,
			turbineId: 0,
			turbineName: String,
			timeStamp: 0001-01-01,
			text: String,
			createdBy: String,
			createdById: 0,
			lastModified: 0001-01-01,
			type: Turbine,
			external: False,
			sticky: False,
			allocationId: 0,
			alarmLogId: 0,
			alarmId: 0,
			commandId: 0,
			relatedInfo: String,
			cleared: False,
			labels: 
			[
				{
					id: 0,
					name: String,
					color: String,
					type: 0
				}
			],
			objectId: String,
			relatedStart: 0001-01-01,
			relatedEnd: 0001-01-01
		}
	]
}

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

{
	comments: 
	[
		{
			id: 0,
			turbineId: 0,
			turbineName: String,
			timeStamp: 0001-01-01,
			text: String,
			createdBy: String,
			createdById: 0,
			lastModified: 0001-01-01,
			type: Turbine,
			external: False,
			sticky: False,
			allocationId: 0,
			alarmLogId: 0,
			alarmId: 0,
			commandId: 0,
			relatedInfo: String,
			cleared: False,
			labels: 
			[
				{
					id: 0,
					name: String,
					color: String,
					type: 0
				}
			],
			objectId: String,
			relatedStart: 0001-01-01,
			relatedEnd: 0001-01-01
		}
	]
}