Trendsic Platform Service

<back to all web services

TermOverrideRequest

Requires Authentication
The following routes are available for this service:
POST,DELETE,OPTIONS/v1/terminology/override
"use strict";
export class IndustryPack {
    /** @param {{PackId?:string,Code?:string,Name?:string,IsActive?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PackId;
    /** @type {string} */
    Code;
    /** @type {string} */
    Name;
    /** @type {boolean} */
    IsActive;
}
export class TermOverride {
    /** @param {{TermKey?:string,Label?:string,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    TermKey;
    /** @type {string} */
    Label;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
}
export class TerminologyAdminResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Packs?:IndustryPack[],SelectedPackId?:string,Terms?:{ [index:string]: string; },Overrides?:TermOverride[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {IndustryPack[]} */
    Packs = [];
    /** @type {?string} */
    SelectedPackId;
    /** @type {{ [index:string]: string; }} */
    Terms = {};
    /** @type {TermOverride[]} */
    Overrides = [];
}
export class TermOverrideRequest {
    /** @param {{TermKey?:string,Label?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    TermKey;
    /** @type {string} */
    Label;
}

JavaScript TermOverrideRequest 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/terminology/override HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	TermKey: String,
	Label: String
}
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
		}
	},
	Packs: 
	[
		{
			PackId: 00000000000000000000000000000000,
			Code: String,
			Name: String,
			IsActive: False
		}
	],
	SelectedPackId: 00000000000000000000000000000000,
	Terms: 
	{
		String: String
	},
	Overrides: 
	[
		{
			TermKey: String,
			Label: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01
		}
	]
}