SearchParameters Data Type

A json used as search criteria when searching for result files and starting file compilations. Some attributes only apply to process of starting file compilations.

Properties
name data type constraints description
from number   The earliest date a measurement could be from.
Is denoted either in unix time 1655965568 (seconds since 1970-01-01T00:00 UTC).
Or in ISO 8601 date-time format (UTC: "2022-06-23T06:26:08Z" or UTC+2: "2022-06-23T06:26:08+02:00")
to number   The latest date a measurement could be from.
Is denoted either in unix time 1655965568 (seconds since 1970-01-01T00:00 UTC).
Or in ISO 8601 date-time format (UTC: "2022-06-23T06:26:08Z" or UTC+2: "2022-06-23T06:26:08+02:00")
date_reference DateReference   If from and to means measurement date (default) or upload to portal date.
include_identifiers ResultFileIdentifier   Option to include identifiers for each result file. See ResultFileIdentifier for more information. Default is NONE.
filename_regexp string   A regular expression matching a file name.
notMatching boolean required boolean If we should treat the filename_regexp as a pattern which is not to be matched. Default value is false.
task-ids array of number   a list of taskIDs
cars array of string   a list of carVINs
wcus array of string   a list of wcuIDs
labels array of string  
result-file-types array of ResultFileTypeTuple   a list of resultfile type tuples
fileIdentifiers array of number   A list of file identifiers to either start a compilation of the files or to be used to look up file metadata via the /v2/result/search services. In either case, file identifiers and other query constraints are mutually exclusive and combining them will yield a 400 Bad request when the json is passed to /v2/result/search.
drec-type DRECType  
includeGPX boolean required boolean Whether a corresponding .gpx file should be included for each result file in the compilation. Default false. Only apply to file compilations.
includeGpxForTypesOnly array of string   
 If includeGPX is true, this list can be used to specify which result file types we will include a .gpx file for.
 See MeasureResult.Type for which types that can be included in this list.
module-names ModuleNames   MDF type of files come with module names or without them. This setting controls how you would like to handle this. Default is KEEP_AS_IS
insert_vin boolean   Include the vehicles VIN in each file name. Defaults to false. Only apply to file compilations.
insert_plate boolean   Include the vehicles plate number in each file name. Defaults to false. Only apply to file compilations.
compress boolean   Whether each file in the archive should be compressed. Default is false. Only apply to file compilations.
compileType CompileType   Controls the type of the returned archive. Default is ZIP.

Example

{
  "from" : "2022-06-23T06:26:08Z",
  "to" : 1655965568,
  "date_reference" : "measurement",
  "include_identifiers" : "NONE",
  "filename_regexp" : "...",
  "notMatching" : true,
  "task-ids" : [ 12345, 12345 ],
  "cars" : [ "...", "..." ],
  "wcus" : [ "...", "..." ],
  "labels" : [ "...", "..." ],
  "result-file-types" : [ {
    "file-type" : "...",
    "file-sub-type" : "..."
  }, {
    "file-type" : "...",
    "file-sub-type" : "..."
  } ],
  "fileIdentifiers" : [ 12345, 12345 ],
  "drec-type" : "JSON",
  "includeGPX" : true,
  "includeGpxForTypesOnly" : [ "...", "..." ],
  "module-names" : "WITHOUT",
  "insert_vin" : true,
  "insert_plate" : true,
  "compress" : true,
  "compileType" : "ZIP"
}