| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/FFAgentConfigTemplate |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FFAgentConfigId | body | Guid | No | |
| TemplateId | body | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| FFAgentConfig | form | FFAgentConfigExtended | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FFSections | form | List<FFSectionExtended> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| AgentId | form | int | No | |
| DateCreated | form | DateTime | No | |
| DateModified | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SectionTypeDesc | form | string | No | |
| FFFields | form | List<FFFieldExtended> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| FFAgentConfigId | form | Guid | No | |
| SectionTypeId | form | int | No | |
| Nickname | form | string | No | |
| ShowHeader | form | bool | No | |
| Header | form | string | No | |
| height | form | int | No | |
| width | form | int | No | |
| x | form | int | No | |
| y | form | int | No | |
| IsActive | form | bool | No | |
| HasBorder | form | bool | No | |
| BorderColor | form | string | No | |
| BorderWidth | form | int | No | |
| BorderRadius | form | int | No | |
| DateCreated | form | DateTime | No | |
| DateModified | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| IsYesNo | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| FFSectionId | form | Guid | No | |
| FieldTypeId | form | int | No | |
| x | form | int | No | |
| y | form | int | No | |
| height | form | int | No | |
| width | form | int | No | |
| Text | form | string | No |
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/FFAgentConfigTemplate HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FFAgentConfigId: 00000000000000000000000000000000,
TemplateId: 00000000000000000000000000000000
}
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
}
}