| GET,OPTIONS | /v1/records/search |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Q | query | string | No | |
| Page | query | int | No | |
| PageSize | query | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Records | form | List<RecordDto> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecordId | form | int | No | |
| RecordKey | form | string | No | |
| Name | form | string | No | |
| SeriesId | form | int? | No | |
| SeriesKey | form | string | No | |
| Classification | form | string | No | |
| Format | form | string | No | |
| Phase | form | string | No | |
| TriggerDate | form | string | No | |
| Staged | form | bool | No | |
| HoldId | form | int? | No | |
| HoldKey | form | string | No | |
| OwnerName | form | string | No | |
| Branch | form | string | No | |
| Barcode | form | string | No | |
| LocJson | form | string | No | |
| MetaJson | form | string | No | |
| FilesJson | form | string | No | |
| VersionsJson | form | string | No | |
| RelatedJson | form | string | No | |
| DisposedJson | form | string | No | |
| CreatedLabel | form | string | No | |
| UpdatedLabel | form | string | No | |
| Lifecycle | form | string | No | |
| RetKind | form | string | No | |
| EligibleDate | form | string | No | |
| MonthsLeft | form | int | No |
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/search 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
}
},
Records:
[
{
RecordId: 0,
RecordKey: String,
Name: String,
SeriesId: 0,
SeriesKey: String,
Classification: String,
Format: String,
Phase: String,
TriggerDate: String,
Staged: False,
HoldId: 0,
HoldKey: String,
OwnerName: String,
Branch: String,
Barcode: String,
LocJson: String,
MetaJson: String,
FilesJson: String,
VersionsJson: String,
RelatedJson: String,
DisposedJson: String,
CreatedLabel: String,
UpdatedLabel: String,
Lifecycle: String,
RetKind: String,
EligibleDate: String,
MonthsLeft: 0
}
]
}