Trendsic Platform Service

<back to all web services

FormUpdateRequest

Requires Authentication
The following routes are available for this service:
PUT/v1/forms/{FormUID}

export class FormStats
{
    public Total: number;
    public NeedDecision: number;
    public Waiting: number;
    public Overdue: number;

    public constructor(init?: Partial<FormStats>) { (Object as any).assign(this, init); }
}

export class FormCard
{
    public FormUID: string;
    public Name: string;
    public Slug: string;
    public Noun: string;
    public NumberPrefix: string;
    public Description: string;
    public Tone: string;
    public Status: string;
    public PublishedVersionNo?: number;
    public PublishedAt?: string;
    public PublishedBy: string;
    public DraftDirty: boolean;
    public DraftUpdatedAt?: string;
    public DraftUpdatedBy: string;
    public PackLabel: string;
    public SettingsJson: string;
    public Stats: FormStats;
    public Offered: string[] = [];
    public CreatedBy: string;
    public CreatedAt?: string;
    public UpdatedAt?: string;

    public constructor(init?: Partial<FormCard>) { (Object as any).assign(this, init); }
}

export class FormDetail extends FormCard
{
    public DraftJson: string;
    public DraftRev: number;
    public SourceTemplateUID?: string;
    public Warnings: string[] = [];
    public AlwaysHidden: string[] = [];

    public constructor(init?: Partial<FormDetail>) { super(init); (Object as any).assign(this, init); }
}

export class FormResponse
{
    public Form: FormDetail;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<FormResponse>) { (Object as any).assign(this, init); }
}

export class FormUpdateRequest
{
    public FormUID: string;
    public Name: string;
    public Noun: string;
    public Description: string;
    public NumberPrefix: string;

    public constructor(init?: Partial<FormUpdateRequest>) { (Object as any).assign(this, init); }
}

TypeScript FormUpdateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /v1/forms/{FormUID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"FormUID":"00000000000000000000000000000000","Name":"String","Noun":"String","Description":"String","NumberPrefix":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Form":{"DraftJson":"String","DraftRev":0,"SourceTemplateUID":"00000000000000000000000000000000","Warnings":["String"],"AlwaysHidden":["String"],"FormUID":"00000000000000000000000000000000","Name":"String","Slug":"String","Noun":"String","NumberPrefix":"String","Description":"String","Tone":"String","Status":"String","PublishedVersionNo":0,"PublishedAt":"0001-01-01T00:00:00.0000000","PublishedBy":"String","DraftDirty":false,"DraftUpdatedAt":"0001-01-01T00:00:00.0000000","DraftUpdatedBy":"String","PackLabel":"String","SettingsJson":"String","Stats":{"Total":0,"NeedDecision":0,"Waiting":0,"Overdue":0},"Offered":["String"],"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}