CompileService v2 Resource

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

POST /v2/result/compile

Performs a general search of result files of any type and creates a compilation of the results.

As a minimum, the from criteria has to be provided. The search will be performed from this date and all result file the requesting user have access to will be included. To narrow down the search, provide additional criteria. See SearchParameters. Note that some parameters in SearchParameters controls how the compilation is archived (zip or tar) and if the compilation will be compressed or not. Default is to zip the archive without compression.

When the compilation job has been created, the compilation can be downloaded immidiately via the link in the Location header in the response or by using the link in the returned CompilationAccepted JSON.

Request Parameters
name type description
auth-token header
Request Body
media type data type
application/json SearchParameters (JSON)
Response Codes
code condition
400 Parameter 'from' have to be included.
201 The compilation can be downloaded via the provided link
Response Body
media type data type description
application/json CompilationAccepted (JSON)
Response Headers
name description
Location The URL where the compilation can be downloaded.

Example

Request
POST /v2/result/compile
Content-Type: application/json
Accept: application/json
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: application/json
Location: ...

                
{
  "message" : "The compilation can be downloaded via the provided link",
  "link" : "https://wice.alkit.se/m2m/v2/result/compile/326d2f6b-3dd2-453b-ae5d-a4708c0b20e5"
}

POST /v2/result/compile/latest

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 cars) or one WCU ID (via wcus) need to be provided. A time slice can be provided by setting from and to, Further, if only a specific file type is of interest, this can be filtered by setting result-file-types.

Request Parameters
name type description
auth-token header
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 se.alkit.sr.model.SearchParameters#fileNameRegExp is not supported.
201 The compilation can be downloaded via the provided link
Response Body
media type data type description
application/json CompilationAccepted (JSON)
Response Headers
name description
Location The URL where the compilation can be downloaded.

Example

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

                
{
  "cars" : [ "abc123" ],
  "from" : 1614729600,
  "to" : 1614816000
}
Response
HTTP/1.1 201 Created
Content-Type: application/json
Location: ...

                
{
  "message" : "The compilation can be downloaded via the provided link",
  "link" : "https://wice.alkit.se/m2m/v2/result/compile/326d2f6b-3dd2-453b-ae5d-a4708c0b20e5"
}

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

Download a single file by providing its id.

Request Parameters
name type description constraints
auth-token header  
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 /v2/result/download/identifier/{id}
Content-Type: */*
Accept: application/octet-stream
auth-token: ...

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

                
...