Trendsic Platform Service

<back to all web services

ImportPreviewRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/import/{Type}/preview
ImportPreviewRequest Parameters:
NameParameterData TypeRequiredDescription
TypepathstringNo
ImportResult Parameters:
NameParameterData TypeRequiredDescription
ImportTypeformstringNo
FileNameformstringNo
DryRunformboolNo
ImportBatchIdformintNo
TotalRowsformintNo
NewRowsformintNo
UpdatedRowsformintNo
SkippedRowsformintNo
ErrorRowsformintNo
RowsformList<ImportRowResult>No
ResponseStatusformResponseStatusNo
ImportRowResult Parameters:
NameParameterData TypeRequiredDescription
LineformintNo
ActionformstringNo
FieldformstringNo
MessageformstringNo
SummaryformstringNo

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/import/{Type}/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	ImportType: String,
	FileName: String,
	DryRun: False,
	ImportBatchId: 0,
	TotalRows: 0,
	NewRows: 0,
	UpdatedRows: 0,
	SkippedRows: 0,
	ErrorRows: 0,
	Rows: 
	[
		{
			Line: 0,
			Action: String,
			Field: String,
			Message: String,
			Summary: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}