| GET,OPTIONS | /v1/records/series |
|---|
"use strict";
export class RecordSeriesStats {
/** @param {{Total?:number,Running?:number,Eligible?:number,Held?:number,Unstarted?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Total;
/** @type {number} */
Running;
/** @type {number} */
Eligible;
/** @type {number} */
Held;
/** @type {number} */
Unstarted;
}
export class ScheduleLogDto {
/** @param {{LogId?:number,SeriesId?:number,Verb?:string,Actor?:string,What?:string,WhenLabel?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
LogId;
/** @type {?number} */
SeriesId;
/** @type {string} */
Verb;
/** @type {string} */
Actor;
/** @type {string} */
What;
/** @type {string} */
WhenLabel;
}
export class RecordSeriesDto {
/** @param {{SeriesId?:number,SourceKey?:string,Code?:string,Name?:string,Years?:number,Permanent?:boolean,RetClass?:string,TriggerEvent?:string,Method?:string,ImageAndDestroy?:boolean,Citation?:string,FieldsJson?:string,Retired?:boolean,Stats?:RecordSeriesStats,History?:ScheduleLogDto[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
SeriesId;
/** @type {string} */
SourceKey;
/** @type {string} */
Code;
/** @type {string} */
Name;
/** @type {number} */
Years;
/** @type {boolean} */
Permanent;
/** @type {string} */
RetClass;
/** @type {string} */
TriggerEvent;
/** @type {string} */
Method;
/** @type {boolean} */
ImageAndDestroy;
/** @type {string} */
Citation;
/** @type {string} */
FieldsJson;
/** @type {boolean} */
Retired;
/** @type {RecordSeriesStats} */
Stats;
/** @type {ScheduleLogDto[]} */
History = [];
}
export class RecordSeriesListResponse {
/** @param {{ResponseStatus?:ResponseStatus,Series?:RecordSeriesDto[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {RecordSeriesDto[]} */
Series = [];
}
export class RecordSeriesListRequest {
/** @param {{IncludeStats?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
IncludeStats;
}
JavaScript RecordSeriesListRequest 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/records/series HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsv
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
}
},
Series:
[
{
SeriesId: 0,
SourceKey: String,
Code: String,
Name: String,
Years: 0,
Permanent: False,
RetClass: String,
TriggerEvent: String,
Method: String,
ImageAndDestroy: False,
Citation: String,
FieldsJson: String,
Retired: False,
Stats:
{
Total: 0,
Running: 0,
Eligible: 0,
Held: 0,
Unstarted: 0
},
History:
[
{
LogId: 0,
SeriesId: 0,
Verb: String,
Actor: String,
What: String,
WhenLabel: String
}
]
}
]
}