| GET,OPTIONS | /v1/records/series |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IncludeStats | query | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Series | form | List<RecordSeriesDto> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SeriesId | form | int | No | |
| SourceKey | form | string | No | |
| Code | form | string | No | |
| Name | form | string | No | |
| Years | form | int | No | |
| Permanent | form | bool | No | |
| RetClass | form | string | No | |
| TriggerEvent | form | string | No | |
| Method | form | string | No | |
| ImageAndDestroy | form | bool | No | |
| Citation | form | string | No | |
| FieldsJson | form | string | No | |
| Retired | form | bool | No | |
| Stats | form | RecordSeriesStats | No | |
| History | form | List<ScheduleLogDto> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Total | form | int | No | |
| Running | form | int | No | |
| Eligible | form | int | No | |
| Held | form | int | No | |
| Unstarted | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LogId | form | int | No | |
| SeriesId | form | int? | No | |
| Verb | form | string | No | |
| Actor | form | string | No | |
| What | form | string | No | |
| WhenLabel | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}]}]}