| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,OPTIONS | /v1/FFAgentConfig |
|---|
"use strict";
export class FFAgentConfig {
/** @param {{Id?:string,AgentId?:number,DateCreated?:string,DateModified?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {number} */
AgentId;
/** @type {string} */
DateCreated;
/** @type {string} */
DateModified;
}
export class FFSection {
/** @param {{Id?:string,FFAgentConfigId?:string,SectionTypeId?:number,Nickname?:string,ShowHeader?:boolean,Header?:string,height?:number,width?:number,x?:number,y?:number,IsActive?:boolean,HasBorder?:boolean,BorderColor?:string,BorderWidth?:number,BorderRadius?:number,DateCreated?:string,DateModified?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {string} */
FFAgentConfigId;
/** @type {number} */
SectionTypeId;
/** @type {string} */
Nickname;
/** @type {boolean} */
ShowHeader;
/** @type {string} */
Header;
/** @type {number} */
height;
/** @type {number} */
width;
/** @type {number} */
x;
/** @type {number} */
y;
/** @type {boolean} */
IsActive;
/** @type {boolean} */
HasBorder;
/** @type {string} */
BorderColor;
/** @type {number} */
BorderWidth;
/** @type {number} */
BorderRadius;
/** @type {string} */
DateCreated;
/** @type {string} */
DateModified;
}
export class FFField {
/** @param {{Id?:string,FFSectionId?:string,FieldTypeId?:number,x?:number,y?:number,height?:number,width?:number,Text?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {string} */
FFSectionId;
/** @type {number} */
FieldTypeId;
/** @type {number} */
x;
/** @type {number} */
y;
/** @type {number} */
height;
/** @type {number} */
width;
/** @type {string} */
Text;
}
export class FFFieldExtended extends FFField {
/** @param {{Name?:string,IsYesNo?:boolean,Id?:string,FFSectionId?:string,FieldTypeId?:number,x?:number,y?:number,height?:number,width?:number,Text?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {boolean} */
IsYesNo;
}
export class FFSectionExtended extends FFSection {
/** @param {{SectionTypeDesc?:string,FFFields?:FFFieldExtended[],Id?:string,FFAgentConfigId?:string,SectionTypeId?:number,Nickname?:string,ShowHeader?:boolean,Header?:string,height?:number,width?:number,x?:number,y?:number,IsActive?:boolean,HasBorder?:boolean,BorderColor?:string,BorderWidth?:number,BorderRadius?:number,DateCreated?:string,DateModified?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
SectionTypeDesc;
/** @type {FFFieldExtended[]} */
FFFields = [];
}
export class FFAgentConfigExtended extends FFAgentConfig {
/** @param {{FFSections?:FFSectionExtended[],Id?:string,AgentId?:number,DateCreated?:string,DateModified?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {FFSectionExtended[]} */
FFSections = [];
}
export class FFAgentConfigResponse {
/** @param {{ResponseStatus?:ResponseStatus,FFAgentConfig?:FFAgentConfigExtended}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {FFAgentConfigExtended} */
FFAgentConfig;
}
export class FFAgentConfigRequest {
/** @param {{FFAgentConfig?:FFAgentConfigExtended}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {FFAgentConfigExtended} */
FFAgentConfig;
}
JavaScript FFAgentConfigRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/FFAgentConfig HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FFAgentConfig:
{
FFSections:
[
{
SectionTypeDesc: String,
FFFields:
[
{
Name: String,
IsYesNo: False,
Id: 00000000000000000000000000000000,
FFSectionId: 00000000000000000000000000000000,
FieldTypeId: 0,
x: 0,
y: 0,
height: 0,
width: 0,
Text: String
}
],
Id: 00000000000000000000000000000000,
FFAgentConfigId: 00000000000000000000000000000000,
SectionTypeId: 0,
Nickname: String,
ShowHeader: False,
Header: String,
height: 0,
width: 0,
x: 0,
y: 0,
IsActive: False,
HasBorder: False,
BorderColor: String,
BorderWidth: 0,
BorderRadius: 0,
DateCreated: 0001-01-01,
DateModified: 0001-01-01
}
],
Id: 00000000000000000000000000000000,
AgentId: 0,
DateCreated: 0001-01-01,
DateModified: 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
}
},
FFAgentConfig:
{
FFSections:
[
{
SectionTypeDesc: String,
FFFields:
[
{
Name: String,
IsYesNo: False,
Id: 00000000000000000000000000000000,
FFSectionId: 00000000000000000000000000000000,
FieldTypeId: 0,
x: 0,
y: 0,
height: 0,
width: 0,
Text: String
}
],
Id: 00000000000000000000000000000000,
FFAgentConfigId: 00000000000000000000000000000000,
SectionTypeId: 0,
Nickname: String,
ShowHeader: False,
Header: String,
height: 0,
width: 0,
x: 0,
y: 0,
IsActive: False,
HasBorder: False,
BorderColor: String,
BorderWidth: 0,
BorderRadius: 0,
DateCreated: 0001-01-01,
DateModified: 0001-01-01
}
],
Id: 00000000000000000000000000000000,
AgentId: 0,
DateCreated: 0001-01-01,
DateModified: 0001-01-01
}
}