Trendsic Platform Service

<back to all web services

MarkupRaiseRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/markup/{AttachmentId}/{VersionNo}/{PageIndex}/shapes/{ShapeId}/{Raise}
MarkupRaiseRequest Parameters:
NameParameterData TypeRequiredDescription
AttachmentIdpathGuidNo
VersionNopathintNo
PageIndexpathintNo
ShapeIdpathstringNo
RaisepathstringNo
ProjectIDbodyint?No
TitlebodystringNo
DescriptionbodystringNo
AreabodystringNo
TradebodystringNo
AssignedSubbodystringNo
PrioritybodystringNo
AskedOfbodystringNo
DisciplinebodystringNo
DueDatebodyDateTime?No
MarkupRaiseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
LinkformDocumentMarkupLinkNo
LinksformList<DocumentMarkupLink>No
DocumentMarkupLink Parameters:
NameParameterData TypeRequiredDescription
DocumentMarkupLinkIDformintNo
AttachmentIdformGuidNo
VersionNoformintNo
PageIndexformintNo
ShapeIdformstringNo
EntityTypeformstringNo
EntityIDformintNo
EntityNoformstringNo
CreatedByformstringNo
CreatedAtformDateTime?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 /v1/markup/{AttachmentId}/{VersionNo}/{PageIndex}/shapes/{ShapeId}/{Raise} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AttachmentId: 00000000000000000000000000000000,
	VersionNo: 0,
	PageIndex: 0,
	ShapeId: String,
	Raise: String,
	ProjectID: 0,
	Title: String,
	Description: String,
	Area: String,
	Trade: String,
	AssignedSub: String,
	Priority: String,
	AskedOf: String,
	Discipline: String,
	DueDate: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Link: 
	{
		DocumentMarkupLinkID: 0,
		AttachmentId: 00000000000000000000000000000000,
		VersionNo: 0,
		PageIndex: 0,
		ShapeId: String,
		EntityType: String,
		EntityID: 0,
		EntityNo: String,
		CreatedBy: String,
		CreatedAt: 0001-01-01
	},
	Links: 
	[
		{
			DocumentMarkupLinkID: 0,
			AttachmentId: 00000000000000000000000000000000,
			VersionNo: 0,
			PageIndex: 0,
			ShapeId: String,
			EntityType: String,
			EntityID: 0,
			EntityNo: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01
		}
	]
}