Trendsic Platform Service

<back to all web services

MappingRuleSaveRequest

Requires Authentication
The following routes are available for this service:
PATCH,PUT,DELETE,OPTIONS/v1/records/mapping-rules/{RuleId}
POST,OPTIONS/v1/records/mapping-rules
"use strict";
export class RecordsOkResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Ok?:boolean,Id?:number,Key?:string,Matches?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {boolean} */
    Ok;
    /** @type {number} */
    Id;
    /** @type {string} */
    Key;
    /** @type {string[]} */
    Matches = [];
}
export class MappingRuleSaveRequest {
    /** @param {{RuleId?:number,SortOrder?:number,Keyword?:string,SeriesId?:number,Active?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    RuleId;
    /** @type {number} */
    SortOrder;
    /** @type {string} */
    Keyword;
    /** @type {number} */
    SeriesId;
    /** @type {boolean} */
    Active;
}

JavaScript MappingRuleSaveRequest DTOs

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/records/mapping-rules HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RuleId: 0,
	SortOrder: 0,
	Keyword: String,
	SeriesId: 0,
	Active: False
}
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
		}
	},
	Ok: False,
	Id: 0,
	Key: String,
	Matches: 
	[
		String
	]
}