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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RecordsSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Settings>
    <ArchivalJson>String</ArchivalJson>
    <PoliciesJson>String</PoliciesJson>
    <ThresholdsJson>String</ThresholdsJson>
    <VendorsJson>String</VendorsJson>
    <VisibilityJson>String</VisibilityJson>
    <WfBindings>
      <WfBindingDto>
        <Name>String</Name>
        <Paused>false</Paused>
        <Runs30>0</Runs30>
        <SourceKey>String</SourceKey>
        <Summary>String</Summary>
        <WorkflowId>0</WorkflowId>
      </WfBindingDto>
    </WfBindings>
  </Settings>
</RecordsSettingsResponse>