Trendsic Platform Service

<back to all web services

RecordsSettingsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/settings
"use strict";
export class WfBindingDto {
    /** @param {{SourceKey?:string,WorkflowId?:number,Name?:string,Paused?:boolean,Runs30?:number,Summary?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SourceKey;
    /** @type {number} */
    WorkflowId;
    /** @type {string} */
    Name;
    /** @type {boolean} */
    Paused;
    /** @type {number} */
    Runs30;
    /** @type {string} */
    Summary;
}
export class RecordsSettingsDto {
    /** @param {{ThresholdsJson?:string,VendorsJson?:string,ArchivalJson?:string,PoliciesJson?:string,VisibilityJson?:string,WfBindings?:WfBindingDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ThresholdsJson;
    /** @type {string} */
    VendorsJson;
    /** @type {string} */
    ArchivalJson;
    /** @type {string} */
    PoliciesJson;
    /** @type {string} */
    VisibilityJson;
    /** @type {WfBindingDto[]} */
    WfBindings = [];
}
export class RecordsSettingsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Settings?:RecordsSettingsDto}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {RecordsSettingsDto} */
    Settings;
}
export class RecordsSettingsRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript RecordsSettingsRequest 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.

GET /v1/records/settings HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	},
	Settings: 
	{
		ThresholdsJson: String,
		VendorsJson: String,
		ArchivalJson: String,
		PoliciesJson: String,
		VisibilityJson: String,
		WfBindings: 
		[
			{
				SourceKey: String,
				WorkflowId: 0,
				Name: String,
				Paused: False,
				Runs30: 0,
				Summary: String
			}
		]
	}
}