CompileService Resource

A set of services related to compiling and downloading result files.

GET /v1/result/compile

This method has been deprecated. Use CompileService v2 instead.

Search and compile result files of any type

Performs a general search of result files of any type and starts compilation of the results. The search is performed between the two given dates or only from the start date if the end date is omitted. If the current user only has access to a subset of all WCU:s/Cars the search is performed on this subset only. Similarly, if the current user only has access to a subset of all assignment types, the search is performed on this subset only.

Request Parameters
name type description constraints
auth-token header The authentication token.  
compress query Whether each file in the zip archive should be compressed. Default is false. boolean
date_reference query If from and to means measurement date (default) or upload to portal date. "measurement" or "upload_to_portal"
drec-type query If the result contains DREC type of file (diagnostic responses) the result files can be formated in different ways. For more information see DRECType. Default is DRECType#RAW "JSON" or "JSON_CFD" or "RAW"
filename_regexp query A regular expression matching a file name.  
from query The earliest date, given in Unix time, a measurement could be from. (Required) long
includeGPX query Whether a corresponding .gpx file should be included for each result file in the compilation. required boolean
include_identifiers query Option to include identifier for each result file. See ResultFileIdentifier for more information. Default is ResultFileIdentifier#NONE. "AS_FILES" or "JSON" or "NONE"
insert_plate query Include the vehicles plate number in each file name. Defaults to false. boolean
insert_vin query Include the vehicles VIN in each file name. Defaults to false. boolean
module-names query MDF type of files come with module names or without them. This setting controls how you would like to handle this. Default is ModuleNames#KEEP_AS_IS "KEEP_AS_IS" or "WITH" or "WITHOUT"
not-matching query If the provided fileRegexp should not be matched, e.g match all result files not matching fileRegExp. Default is false. boolean
to query The latest date, given in Unix time, a measurement could be from. long
Response Codes
code condition
400 Parameter 'from' have to be included.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
GET /v1/result/compile
Content-Type: */*
Accept: text/plain
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...

POST /v1/result/compile

This method has been deprecated. Use CompileService v2 instead.

Search and compile result files of any type

Performs a general search of result files of any type and starts compilation of the results. The search is performed between the two given dates or only from the start date if the end date is omitted. If the current user only has access to a subset of all WCU:s/Cars the search is performed on this subset only. Similarly, if the current user only has access to a subset of all assignment types, the search is performed on this subset only.

Request Parameters
name type description
auth-token header The authentication token.
Request Body
media type data type
application/json SearchParameters (JSON)
Response Codes
code condition
400 Parameter 'from' have to be included.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
POST /v1/result/compile
Content-Type: application/json
Accept: text/plain
auth-token: ...

                
{
  "from" : "2022-06-23T06:26:08Z",
  "to" : 1655965568,
  "date_reference" : "upload_to_portal",
  "include_identifiers" : "JSON",
  "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"
}
Response
HTTP/1.1 201 Created
Content-Type: text/plain

                
...

GET /v1/result/compile/available-workers

This method has been deprecated. Use CompileService v2 instead.

Returns the number of available compilation workers.

A value > 0 means that there are workers available and a new compilation will be started immidiately.
0 means that all workers are busy and a new compilation request will be added first in the queue
A value < 0 means that all workers are busy and there are compilations in the queue. The absolute value represents the number of the compilations waiting in the queue.

Request Parameters
name type description
auth-token header The authentication token.
Response Body
media type data type description
text/plain number The number of available compilation workers.

Example

Request
GET /v1/result/compile/available-workers
Content-Type: */*
Accept: text/plain
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...

GET /v1/result/compile/identifiers

This method has been deprecated. Use CompileService v2 instead.

Start a compilation based on a list of file identifiers.

Request Parameters
name type description constraints multivalued
auth-token header The authentication token.   no
compress query Whether each file in the zip archive should be compressed. Default is false. boolean no
drec-type query If the result contains DREC type of file (diagnostic responses) the result files can be formated in different ways. For more information see DRECType. Default is DRECType#RAW "JSON" or "JSON_CFD" or "RAW" no
fileIdentifiers query int yes
includeGPX query Whether a corresponding .gpx file should be included for each result file in the compilation. required boolean no
insert_plate query Include the vehicles plate number in each file name. Defaults to false. boolean no
insert_vin query Include the vehicles VIN in each file name. Defaults to false. boolean no
module-names query MDF type of files come with module names or without them. This setting controls how you would like to handle this. Default is ModuleNames#KEEP_AS_IS "KEEP_AS_IS" or "WITH" or "WITHOUT" no
Response Codes
code condition
400 You have to provide at least one file identifier.
401 You don't have access to at least one of the provided files.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
GET /compile/identifiers?fileIdentifiers=123,456
Content-Type: */*
Accept: text/plain
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...

POST /v1/result/compile/identifiers

This method has been deprecated. Use CompileService v2 instead.

Start a compilation base on a list of file identifiers.

Request Parameters
name type description
auth-token header The authentication token.
Request Body
media type data type description
application/json SearchParameters (JSON) SearchParameters
Response Codes
code condition
400 You have to provide at least one file identifier.
401 You don't have access to at least one of the provided files.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
POST /v1/result/compile/identifiers
Content-Type: application/json
Accept: text/plain
auth-token: ...

                
{
  "from" : "2022-06-23T06:26:08Z",
  "to" : 1655965568,
  "date_reference" : "upload_to_portal",
  "include_identifiers" : "JSON",
  "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" : "WITH",
  "insert_vin" : true,
  "insert_plate" : true,
  "compress" : true,
  "compileType" : "TAR"
}
Response
HTTP/1.1 201 Created
Content-Type: text/plain

                
...

GET /v1/result/compile/latest

This method has been deprecated. Use CompileService v2 instead.

Start a compilation of the latest result and log files for the provided vehicles the requesting user has access to.

At least one vehicle VIN or one WCU ID must to be provided. Both a VIN and a WCU ID can be provided and if they resolve to two unique vehicles, both these vehicles are included in the results. A time slice can be provided by via ?from=unix_timestamp and ?to=unix_timestamp (See example) Further, if only a specific file type is of interest, this can be filtered by setting ?result-file-types=[text,text_common_timebase]. See ResultFileTypeTuple

Request Parameters
name type description constraints multivalued
auth-token header The authentication token.   no
cars query A list of vehicle VINs.   yes
from query A unix timestamp long no
result-file-types query a list of resultfile type tuples. See example and ResultFileTypeTuple   yes
to query A unix timestamp long no
wcus query A list of WCU IDs.   yes
Response Codes
code condition
400 You have to provide at least one VIN or one WCU ID.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
GET /compile/latest/?result-file-types=[log,no_subtype]&cars=VIN1?from=1614729600&to=1614816000
Content-Type: */*
Accept: text/plain
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...

POST /v1/result/compile/latest

This method has been deprecated. Use CompileService v2 instead.

Start a compilation of the latest result and log files for the provided vehicles the requesting user has access to.

At least one vehicle VIN (via SearchParameters#carVINs) or one WCU ID (via SearchParameters#wcuIDs) need to be provided. A time slice can be provided by setting SearchParameters#from and SearchParameters#to, Further, if only a specific file type is of interest, this can be filtered by setting SearchParameters#resultFileTypes.

Request Parameters
name type description
auth-token header The authentication token.
Request Body
media type data type
application/json SearchParameters (JSON)
Response Codes
code condition
400 You have to provide at least one VIN or one WCU ID.
400 SearchParameters#fileNameRegExp is not supported.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
POST /v1/result/compile/latest
Content-Type: application/json
Accept: text/plain
auth-token: ...

                
{
  "cars" : [ "abc123" ],
  "from" : 1614729600,
  "to" : 1614816000
}
Response
HTTP/1.1 201 Created
Content-Type: text/plain

                
...

GET /v1/result/compile/result-file-types

This method has been deprecated. Use CompileService v2 instead.

Search and compile result files based on a subset of result file [type, sub-type] tuples.

Performs a general search based on a subset of result file [type, sub-type] tuples and compiles the result.

Request Parameters
name type description constraints multivalued
auth-token header The authentication token.   no
compress query Whether each file in the zip archive should be compressed. Default is false. boolean no
date_reference query If from and to means measurement date (default) or upload to portal date. "measurement" or "upload_to_portal" no
drec-type query If the result contains DREC type of file (diagnostic responses) the result files can be formated in different ways. For more information see DRECType. Default is DRECType#RAW "JSON" or "JSON_CFD" or "RAW" no
filename_regexp query A regular expression matching a file name.   no
from query The earliest date, given in Unix time, a measurement could be from. (Required) long no
includeGPX query Whether a corresponding .gpx file should be included for each result file in the compilation. required boolean no
include_identifiers query Option to include identifier for each result file. See ResultFileIdentifier for more information. Default is ResultFileIdentifier#NONE. "AS_FILES" or "JSON" or "NONE" no
insert_plate query Include the vehicles plate number in each file name. Defaults to false. boolean no
insert_vin query Include the vehicles VIN in each file name. Defaults to false. boolean no
module-names query MDF type of files come with module names or without them. This setting controls how you would like to handle this. Default is ModuleNames#KEEP_AS_IS "KEEP_AS_IS" or "WITH" or "WITHOUT" no
not-matching query If the provided fileRegexp should not be matched, e.g match all result files not matching fileRegExp. Default is false. boolean no
result-file-types query a list of resultfile type tuples (Required)   yes
to query The latest date, given in Unix time, a measurement could be from. long no
Response Codes
code condition
400 Parameter 'from' have to be included.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
GET /compile/result-file-types?from=1584456135&result-file-types=[text,text_common_timebase]
Content-Type: */*
Accept: text/plain
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...

POST /v1/result/compile/result-file-types

This method has been deprecated. Use CompileService v2 instead.

Search and compile result files based on a subset of result file [type, sub-type] tuples.

Performs a general search based on a subset of result file [type, sub-type] tuples and compiles the result.

Request Parameters
name type description
auth-token header The authentication token.
Request Body
media type data type description
application/json SearchParameters (JSON) SearchParameters
Response Codes
code condition
400 Parameter 'from' have to be included.
400 You have to provide at least one result file type tuple!
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
POST /v1/result/compile/result-file-types
Content-Type: application/json
Accept: text/plain
auth-token: ...

                
{
  "from" : "2022-06-23T06:26:08Z",
  "to" : 1655965568,
  "date_reference" : "upload_to_portal",
  "include_identifiers" : "JSON",
  "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" : "RAW",
  "includeGPX" : true,
  "includeGpxForTypesOnly" : [ "...", "..." ],
  "module-names" : "WITHOUT",
  "insert_vin" : true,
  "insert_plate" : true,
  "compress" : true,
  "compileType" : "ZIP"
}
Response
HTTP/1.1 201 Created
Content-Type: text/plain

                
...

GET /v1/result/compile/task-ids

This method has been deprecated. Use CompileService v2 instead.

Search and compile result files of any type with a given set of taskIDs

Performs a general search of result files of any type but for specific taskIDs and starts compilation of the results.

Request Parameters
name type description constraints multivalued
auth-token header The authentication token.   no
compress query Whether each file in the zip archive should be compressed. Default is false. boolean no
date_reference query If from and to means measurement date (default) or upload to portal date. "measurement" or "upload_to_portal" no
drec-type query If the result contains DREC type of file (diagnostic responses) the result files can be formated in different ways. For more information see DRECType. Default is DRECType#RAW "JSON" or "JSON_CFD" or "RAW" no
filename_regexp query A regular expression matching a file name.   no
from query The earliest date, given in Unix time, a measurement could be from. (Required) long no
includeGPX query Whether a corresponding .gpx file should be included for each result file in the compilation. required boolean no
include_identifiers query Option to include identifier for each result file. See ResultFileIdentifier for more information. Default is ResultFileIdentifier#NONE. "AS_FILES" or "JSON" or "NONE" no
insert_plate query Include the vehicles plate number in each file name. Defaults to false. boolean no
insert_vin query Include the vehicles VIN in each file name. Defaults to false. boolean no
module-names query MDF type of files come with module names or without them. This setting controls how you would like to handle this. Default is ModuleNames#KEEP_AS_IS "KEEP_AS_IS" or "WITH" or "WITHOUT" no
not-matching query If the provided fileRegexp should not be matched, e.g match all result files not matching fileRegExp. Default is false. boolean no
taskids query a list of taskIDs (Required) int yes
to query The latest date, given in Unix time, a measurement could be from. long no
Response Codes
code condition
400 Parameter 'from' have to be included.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
GET /v1/result/compile/task-ids
Content-Type: */*
Accept: text/plain
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...

POST /v1/result/compile/task-ids

This method has been deprecated. Use CompileService v2 instead.

Search and compile result files of any type with a given set of taskIDs

Performs a general search of result files of any type but for specific taskIDs and starts compilation of the results.

Request Parameters
name type description
auth-token header The authentication token.
Request Body
media type data type
application/json SearchParameters (JSON)
Response Codes
code condition
400 Parameter 'from' have to be included.
400 You have to provide at least one taskID.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
POST /v1/result/compile/task-ids
Content-Type: application/json
Accept: text/plain
auth-token: ...

                
{
  "from" : "2022-06-23T06:26:08Z",
  "to" : 1655965568,
  "date_reference" : "upload_to_portal",
  "include_identifiers" : "JSON",
  "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"
}
Response
HTTP/1.1 201 Created
Content-Type: text/plain

                
...

GET /v1/result/compile/{uuid}

This method has been deprecated. Use CompileService v2 instead.

Get status of compilation.

Gets the status of a previously started compilation of result files.

Request Parameters
name type description constraints
auth-token header The authentication token.  
uuid path The UUID from a previously started compilation. required
Response Codes
code condition
400 You have to provide an uiid.
Response Body
media type data type description
text/plain object A value between 0 and 100. 100 means that the compilation is ready for download.

Example

Request
GET /v1/result/compile/{uuid}
Content-Type: */*
Accept: text/plain
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...

GET /v1/result/download/{uuid}

This method has been deprecated. Use CompileService v2 instead.

Download a compilation.

Download a compilation which is ready for download. If the compilation is not ready, an error message is returned.

Request Parameters
name type description constraints
auth-token header The authentication token.  
uuid path The UUID from a previously started compilation. required
Response Codes
code condition
400 You have to provide a UUID.
412 Compilation not ready for download yet.
Response Body
media type data type description
application/octet-stream object The requested compilation as a .zip file.

Example

Request
GET /v1/result/download/{uuid}
Content-Type: */*
Accept: application/octet-stream
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/octet-stream

                
...

GET /v1/result/compile/result-file-types/cars

This method has been deprecated. Use CompileService v2 instead.

Search and compile result files based on a subset of result file [type, sub-type] tuples and cars.

Performs a general search based on a subset of result file [type, sub-type] tuples and a list of carVINs and then compiles the result.

Request Parameters
name type description constraints multivalued
auth-token header The authentication token.   no
cars query a list of carVINs (Required)   yes
compress query Whether each file in the zip archive should be compressed. Default is false. boolean no
date_reference query If from and to means measurement date (default) or upload to portal date. "measurement" or "upload_to_portal" no
drec-type query If the result contains DREC type of file (diagnostic responses) the result files can be formated in different ways. For more information see DRECType. Default is DRECType#RAW "JSON" or "JSON_CFD" or "RAW" no
filename_regexp query A regular expression matching a file name.   no
from query The earliest date, given in Unix time, a measurement could be from. (Required) long no
includeGPX query Whether a corresponding .gpx file should be included for each result file in the compilation. required boolean no
include_identifiers query Option to include identifier for each result file. See ResultFileIdentifier for more information. Default is ResultFileIdentifier#NONE. "AS_FILES" or "JSON" or "NONE" no
insert_plate query Include the vehicles plate number in each file name. Defaults to false. boolean no
insert_vin query Include the vehicles VIN in each file name. Defaults to false. boolean no
module-names query MDF type of files come with module names or without them. This setting controls how you would like to handle this. Default is ModuleNames#KEEP_AS_IS "KEEP_AS_IS" or "WITH" or "WITHOUT" no
not-matching query If the provided fileRegexp should not be matched, e.g match all result files not matching fileRegExp. Default is false. boolean no
result-file-types query a list of resultfile type tuples (Required)   yes
to query The latest date, given in Unix time, a measurement could be from. long no
Response Codes
code condition
400 Parameter 'from' have to be included.
400 You have to provide at least one result file type tuple!
400 You have to provide at least one VIN.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
GET /compile/result-file-types/cars?from=1584456135&result-file-types=[text,text_common_timebase]&cars=VIN1
Content-Type: */*
Accept: text/plain
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...

POST /v1/result/compile/result-file-types/cars

This method has been deprecated. Use CompileService v2 instead.

Search and compile result files based on a subset of result file [type, sub-type] tuples and cars.

Performs a general search based on a subset of result file [type, sub-type] tuples and a list of carVINs and then compiles the result.

Request Parameters
name type description
auth-token header The authentication token.
Request Body
media type data type description
application/json SearchParameters (JSON) SearchParameters
Response Codes
code condition
400 Parameter 'from' have to be included.
400 You have to provide at least one result file type tuple!
400 You have to provide at least one VIN.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
POST /v1/result/compile/result-file-types/cars
Content-Type: application/json
Accept: text/plain
auth-token: ...

                
{
  "from" : "2022-06-23T06:26:08Z",
  "to" : 1655965568,
  "date_reference" : "upload_to_portal",
  "include_identifiers" : "JSON",
  "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_CFD",
  "includeGPX" : true,
  "includeGpxForTypesOnly" : [ "...", "..." ],
  "module-names" : "WITH",
  "insert_vin" : true,
  "insert_plate" : true,
  "compress" : true,
  "compileType" : "ZIP"
}
Response
HTTP/1.1 201 Created
Content-Type: text/plain

                
...

GET /v1/result/compile/result-file-types/wcus

This method has been deprecated. Use CompileService v2 instead.

Search and compile result files based on a subset of result file [type, sub-type] tuples and wcus.

Performs a general search based on a subset of result file [type, sub-type] tuples and a list of wcuIDs and then compiles the result.

Request Parameters
name type description constraints multivalued
auth-token header The authentication token.   no
compress query Whether each file in the zip archive should be compressed. Default is false. boolean no
date_reference query If from and to means measurement date (default) or upload to portal date. "measurement" or "upload_to_portal" no
drec-type query If the result contains DREC type of file (diagnostic responses) the result files can be formated in different ways. For more information see DRECType. Default is DRECType#RAW "JSON" or "JSON_CFD" or "RAW" no
filename_regexp query A regular expression matching a file name.   no
from query The earliest date, given in Unix time, a measurement could be from. (Required) long no
includeGPX query Whether a corresponding .gpx file should be included for each result file in the compilation. required boolean no
include_identifiers query Option to include identifier for each result file. See ResultFileIdentifier for more information. Default is ResultFileIdentifier#NONE. "AS_FILES" or "JSON" or "NONE" no
insert_plate query Include the vehicles plate number in each file name. Defaults to false. boolean no
insert_vin query Include the vehicles VIN in each file name. Defaults to false. boolean no
module-names query MDF type of files come with module names or without them. This setting controls how you would like to handle this. Default is ModuleNames#KEEP_AS_IS "KEEP_AS_IS" or "WITH" or "WITHOUT" no
not-matching query If the provided fileRegexp should not be matched, e.g match all result files not matching fileRegExp. Default is false. boolean no
result-file-types query a list of resultfile type tuples (Required)   yes
to query The latest date, given in Unix time, a measurement could be from. long no
wcus query a list of wcuIDs (Required)   yes
Response Codes
code condition
400 Parameter 'from' have to be included.
400 You have to provide at least one result file type tuple!
400 You have to provide at least one wcuID.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
GET /compile/result-file-types/wcus?from=1584456135&result-file-types=[text,text_common_timebase]&wcus=WCU1
Content-Type: */*
Accept: text/plain
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...

POST /v1/result/compile/result-file-types/wcus

This method has been deprecated. Use CompileService v2 instead.

Search and compile result files based on a subset of result file [type, sub-type] tuples and wcus.

Performs a general search based on a subset of result file [type, sub-type] tuples and a list of wcuIDs and then compiles the result.

Request Parameters
name type description
auth-token header The authentication token.
Request Body
media type data type description
application/json SearchParameters (JSON) SearchParameters
Response Codes
code condition
400 Parameter 'from' have to be included.
400 You have to provide at least one result file type tuple!
400 You have to provide at least one wcuID.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
POST /v1/result/compile/result-file-types/wcus
Content-Type: application/json
Accept: text/plain
auth-token: ...

                
{
  "from" : "2022-06-23T06:26:08Z",
  "to" : 1655965568,
  "date_reference" : "upload_to_portal",
  "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" : "RAW",
  "includeGPX" : true,
  "includeGpxForTypesOnly" : [ "...", "..." ],
  "module-names" : "WITH",
  "insert_vin" : true,
  "insert_plate" : true,
  "compress" : true,
  "compileType" : "TAR"
}
Response
HTTP/1.1 201 Created
Content-Type: text/plain

                
...

GET /v1/result/compile/task-ids/cars

This method has been deprecated. Use CompileService v2 instead.

Search and compile result files of any type with a given set of taskIDs and carVINs.

Performs a general search of result files of any type but for specific taskIDs and carVINs and starts compilation of the results.

Request Parameters
name type description constraints multivalued
auth-token header The authentication token.   no
cars query a list of carVINs (Required)   yes
compress query Whether each file in the zip archive should be compressed. Default is false. boolean no
date_reference query If from and to means measurement date (default) or upload to portal date. "measurement" or "upload_to_portal" no
drec-type query If the result contains DREC type of file (diagnostic responses) the result files can be formated in different ways. For more information see DRECType. Default is DRECType#RAW "JSON" or "JSON_CFD" or "RAW" no
filename_regexp query A regular expression matching a file name.   no
from query The earliest date, given in Unix time, a measurement could be from. (Required) long no
includeGPX query Whether a corresponding .gpx file should be included for each result file in the compilation. required boolean no
include_identifiers query Option to include identifier for each result file. See ResultFileIdentifier for more information. Default is ResultFileIdentifier#NONE. "AS_FILES" or "JSON" or "NONE" no
insert_plate query Include the vehicles plate number in each file name. Defaults to false. boolean no
insert_vin query Include the vehicles VIN in each file name. Defaults to false. boolean no
module-names query MDF type of files come with module names or without them. This setting controls how you would like to handle this. Default is ModuleNames#KEEP_AS_IS "KEEP_AS_IS" or "WITH" or "WITHOUT" no
not-matching query If the provided fileRegexp should not be matched, e.g match all result files not matching fileRegExp. Default is false. boolean no
taskids query a list of taskIDs (Required) int yes
to query The latest date, given in Unix time, a measurement could be from. long no
Response Codes
code condition
400 Parameter 'from' have to be included.
400 You have to provide at least one taskID.
400 You have to provide at least one VIN.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
GET /compile/task-ids/cars?from=1584456135&task-ids=12345&cars=VIN1&cars=VIN2
Content-Type: */*
Accept: text/plain
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...

POST /v1/result/compile/task-ids/cars

This method has been deprecated. Use CompileService v2 instead.

Search and compile result files of any type with a given set of taskIDs and carVINs.

Performs a general search of result files of any type but for specific taskIDs and carVINs and starts compilation of the results.

Request Parameters
name type description
auth-token header The authentication token.
Request Body
media type data type
application/json SearchParameters (JSON)
Response Codes
code condition
400 Parameter 'from' have to be included.
400 You have to provide at least one taskID.
400 You have to provide at least one VIN.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
POST /v1/result/compile/task-ids/cars
Content-Type: application/json
Accept: text/plain
auth-token: ...

                
{
  "from" : "2022-06-23T06:26:08Z",
  "to" : 1655965568,
  "date_reference" : "upload_to_portal",
  "include_identifiers" : "AS_FILES",
  "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" : "TAR"
}
Response
HTTP/1.1 201 Created
Content-Type: text/plain

                
...

GET /v1/result/compile/task-ids/wcus

This method has been deprecated. Use CompileService v2 instead.

Search and compile result files of any type with a given set of taskIDs and wcuIDs.

Performs a general search of result files of any type but for specific taskIDs and wcuIDs and starts compilation of the results.

Request Parameters
name type description constraints multivalued
auth-token header The authentication token.   no
compress query Whether each file in the zip archive should be compressed. Default is false. boolean no
date_reference query If from and to means measurement date (default) or upload to portal date. "measurement" or "upload_to_portal" no
drec-type query If the result contains DREC type of file (diagnostic responses) the result files can be formated in different ways. For more information see DRECType. Default is DRECType#RAW "JSON" or "JSON_CFD" or "RAW" no
filename_regexp query A regular expression matching a file name.   no
from query The earliest date, given in Unix time, a measurement could be from. (Required) long no
includeGPX query Whether a corresponding .gpx file should be included for each result file in the compilation. required boolean no
include_identifiers query Option to include identifier for each result file. See ResultFileIdentifier for more information. Default is ResultFileIdentifier#NONE. "AS_FILES" or "JSON" or "NONE" no
insert_plate query Include the vehicles plate number in each file name. Defaults to false. boolean no
insert_vin query Include the vehicles VIN in each file name. Defaults to false. boolean no
module-names query MDF type of files come with module names or without them. This setting controls how you would like to handle this. Default is ModuleNames#KEEP_AS_IS "KEEP_AS_IS" or "WITH" or "WITHOUT" no
not-matching query If the provided fileRegexp should not be matched, e.g match all result files not matching fileRegExp. Default is false. boolean no
taskids query a list of taskIDs (Required) int yes
to query The latest date, given in Unix time, a measurement could be from. long no
wcus query a list of wcuIDs (Required)   yes
Response Codes
code condition
400 Parameter 'from' have to be included.
400 You have to provide at least one taskID.
400 You have to provide at least one wcuID.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
GET /compile/task-ids/wcus?from=1584456135&task-ids=12345&wcus=WCU1&cars=WCU2
Content-Type: */*
Accept: text/plain
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...

POST /v1/result/compile/task-ids/wcus

This method has been deprecated. Use CompileService v2 instead.

Search and compile result files of any type with a given set of taskIDs and wcuIDs.

Performs a general search of result files of any type but for specific taskIDs and wcuIDs and starts compilation of the results.

Request Parameters
name type description
auth-token header The authentication token.
Request Body
media type data type description
application/json SearchParameters (JSON) SearchParameters
Response Codes
code condition
400 Parameter 'from' have to be included.
400 You have to provide at least one taskID.
400 You have to provide at least one wcuID.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
POST /v1/result/compile/task-ids/wcus
Content-Type: application/json
Accept: text/plain
auth-token: ...

                
{
  "from" : "2022-06-23T06:26:08Z",
  "to" : 1655965568,
  "date_reference" : "measurement",
  "include_identifiers" : "JSON",
  "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" : "RAW",
  "includeGPX" : true,
  "includeGpxForTypesOnly" : [ "...", "..." ],
  "module-names" : "WITH",
  "insert_vin" : true,
  "insert_plate" : true,
  "compress" : true,
  "compileType" : "ZIP"
}
Response
HTTP/1.1 201 Created
Content-Type: text/plain

                
...

GET /v1/result/download/identifier/{id}

This method has been deprecated. Use CompileService v2 instead.

Download a single file by providing its id.

Request Parameters
name type description constraints
auth-token header The authentication token.  
id path required long
Response Codes
code condition
401 You are not permitted to access the requested file.
Response Body
media type data type description
application/octet-stream object The requested file

Example

Request
GET /v1/result/download/identifier/{id}
Content-Type: */*
Accept: application/octet-stream
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/octet-stream

                
...

GET /v1/result/compile/task-ids/wcus/latest

This method has been deprecated. Use CompileService v2 instead.

Searches and compiles the latest result file each of the taskIDs and wcuIDs.

Performs a search for the latest result file of any type but for specific taskIDs and wcuIDs and starts a compilation of the result files.

Request Parameters
name type description constraints multivalued
auth-token header The authentication token.   no
compress query Whether each file in the zip archive should be compressed. Default is false. boolean no
drec-type query If the result contains DREC type of file (diagnostic responses) the result files "JSON" or "JSON_CFD" or "RAW" no
insert_plate query Include the vehicles plate number in each file name. Defaults to false. boolean no
insert_vin query Include the vehicles VIN in each file name. Defaults to false. boolean no
module-names query MDF type of files come with module names or without them. This setting controls how you would like to handle this. Default is ModuleNames#KEEP_AS_IS "KEEP_AS_IS" or "WITH" or "WITHOUT" no
taskids query a list of taskIDs (Required) int yes
wcus query a list of wcuIDs (Required)   yes
Response Codes
code condition
400 Parameter 'from' have to be included.
400 You have to provide at least one taskID.
400 You have to provide at least one wcuID.
404 No latest file found for the input.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
GET /compile/task-ids/wcus/latest?task-ids=12345&wcus=WCU1&wcus=WCU2
Content-Type: */*
Accept: text/plain
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...

POST /v1/result/compile/task-ids/wcus/latest

This method has been deprecated. Use CompileService v2 instead.

Searches and compiles the latest result file each of the taskIDs and wcuIDs.

Performs a search for the latest result file of any type but for specific taskIDs and wcuIDs and starts a compilation of the result files.

Request Parameters
name type description
auth-token header The authentication token.
Request Body
media type data type description
application/json SearchParameters (JSON) SearchParameters
Response Codes
code condition
400 You have to provide at least one taskID.
400 You have to provide at least one wcuID.
404 No latest file found for the input.
Response Body
media type data type description
text/plain string A UUID identifying the compilation

Example

Request
POST /v1/result/compile/task-ids/wcus/latest
Content-Type: application/json
Accept: text/plain
auth-token: ...

                
{
  "from" : "2022-06-23T06:26:08Z",
  "to" : 1655965568,
  "date_reference" : "measurement",
  "include_identifiers" : "JSON",
  "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" : "RAW",
  "includeGPX" : true,
  "includeGpxForTypesOnly" : [ "...", "..." ],
  "module-names" : "KEEP_AS_IS",
  "insert_vin" : true,
  "insert_plate" : true,
  "compress" : true,
  "compileType" : "ZIP"
}
Response
HTTP/1.1 201 Created
Content-Type: text/plain

                
...