| GET | /v1/forms |
|---|
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 FormListResponse
{
public Forms: FormCard[] = [];
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<FormListResponse>) { (Object as any).assign(this, init); }
}
export class FormListRequest
{
public constructor(init?: Partial<FormListRequest>) { (Object as any).assign(this, init); }
}
TypeScript FormListRequest 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.
GET /v1/forms HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Forms:
[
{
FormUID: 00000000000000000000000000000000,
Name: String,
Slug: String,
Noun: String,
NumberPrefix: String,
Description: String,
Tone: String,
Status: String,
PublishedVersionNo: 0,
PublishedAt: 0001-01-01,
PublishedBy: String,
DraftDirty: False,
DraftUpdatedAt: 0001-01-01,
DraftUpdatedBy: String,
PackLabel: String,
SettingsJson: String,
Stats:
{
Total: 0,
NeedDecision: 0,
Waiting: 0,
Overdue: 0
},
Offered:
[
String
],
CreatedBy: String,
CreatedAt: 0001-01-01,
UpdatedAt: 0001-01-01
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}