Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
AssignmentService
  • /v1/assignment/list
  • /v1/assignment/area5/{id}
  • /v1/assignment/idc/{id}
  • /v1/assignment/sequence_file/{id}
  • /v1/assignment/signal_reader/{id}
  • /v1/assignment/signal_reader/copy/{id}
  • /v1/assignment/signal_reader/{id}/drec
  • /v1/assignment/signal_reader/copy/result/{uuid}
  • /v1/assignment/signal_reader/copy/{id}/referenced-associations
  • /v1/assignment/signal_reader/{id}/signals/srec
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • GET
  • GET
  • GET
  • GET
A set of services related to assignments.
AuthService
  • /v1/auth/login
  • /v1/auth/logout
  • POST
  • DELETE POST
A set of services for authentication. After a successful login, an authorization token is either delivered in the response header or returned as a string depending on which login end point being used. The token must then be included on subsequent calls when using other end points. The token expires after 8 hours if it has not been used but the expiration time is reset after a successfull call to an end point that requires authorization.
CompileService
  • /v1/result/compile
  • /v1/result/compile/available-workers
  • /v1/result/compile/identifiers
  • /v1/result/compile/latest
  • /v1/result/compile/result-file-types
  • /v1/result/compile/task-ids
  • /v1/result/compile/{uuid}
  • /v1/result/download/{uuid}
  • /v1/result/compile/result-file-types/cars
  • /v1/result/compile/result-file-types/wcus
  • /v1/result/compile/task-ids/cars
  • /v1/result/compile/task-ids/wcus
  • /v1/result/download/identifier/{id}
  • /v1/result/compile/task-ids/wcus/latest
  • GET POST
  • GET
  • GET POST
  • GET POST
  • GET POST
  • GET POST
  • GET
  • GET
  • GET POST
  • GET POST
  • GET POST
  • GET POST
  • GET
  • GET POST
A set of services related to compiling and downloading result files.
CompileService v2
  • /v2/result/compile
  • /v2/result/compile/latest
  • /v2/result/download/identifier/{id}
  • POST
  • POST
  • GET
A set of services related to compiling and downloading result files.
DiagnosticsService
  • /v1/diagnostics/vehicle/{vin}/latest
  • GET
EditSignalReaderAssignmentService
  • /v1/assignment/signal_reader/edit/{id}/measurement-setups
  • /v1/assignment/signal_reader/edit/{id}/rename
  • /v1/assignment/signal_reader/edit/{id}/signal_sources
  • /v1/assignment/signal_reader/edit/{id}/signals
  • /v1/assignment/signal_reader/edit/{id}/drec/replace-seq-file
  • /v1/assignment/signal_reader/edit/{id}/srec/signals/add
  • GET
  • PUT
  • GET
  • POST
  • PUT
  • PUT
A set of services related to editing Signal reader assignments.
LabelService
  • /v1/label/search
  • GET
PingService
  • /v1/adm/build
  • /v1/adm/ping
  • /v1/adm/version
  • GET
  • GET
  • GET
A set of services used to get basic information about the service as a whole.
ResourceGroupService
  • /v1/resourcegroup/resultfile
  • /v1/resourcegroup/{resource-group}/members/history
  • POST
  • GET
A set of end point that concerns resource resource groups.
SearchService
  • /v1/result/search
  • /v1/result/search/cars
  • /v1/result/search/labels
  • /v1/result/search/latest
  • /v1/result/search/result-file-types
  • /v1/result/search/task-ids
  • /v1/result/search/wcus
  • /v1/result/search/result-file-types/cars
  • /v1/result/search/result-file-types/wcus
  • /v1/result/search/task-ids/cars
  • /v1/result/search/task-ids/wcus
  • GET POST
  • GET POST
  • GET
  • GET POST
  • GET POST
  • GET POST
  • GET POST
  • GET POST
  • GET POST
  • GET POST
  • GET POST
Deprecated and will be removed in a future release. Please use migrate to v2.
SearchService v2
  • /v2/result/search
  • /v2/result/search/latest
  • /v2/result/search/{uuid}
  • /v2/result/search/latest/{uuid}
  • POST
  • POST
  • GET
  • GET
A set of services related to searching of result files
TaskSearchService
  • /v1/task/search
  • GET
A set of services related to searching for tasks.
TaskService
  • /v1/task/downloadProgram
  • /v1/task/list
  • /v1/task/{task_id}
  • /v1/task/create/idc
  • /v1/task/create/signalreader
  • /v1/task/create/soh
  • /v1/task/create/swdl
  • /v1/task/list/{type}
  • /v1/task/servertrigger/task
  • /v1/task/upload/vbf
  • /v1/task/{task_id}/type
  • /v1/task/status/{task_id}/car/{car_id}
  • /v1/task/stop/{task_id}/car/{car_id}
  • /v1/task/result/count/{task_id}/car/{car_id}
  • /v1/task/result/file/{task_id}/car/{car_id}
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • POST
  • GET
  • GET
  • POST
  • GET
  • GET
  • PUT
  • GET
  • GET
A set of services related to tasks.
UserService
  • /v1/user/cars/rights
  • /v1/user/cars/rights/rg
  • GET
  • GET
A set of functions for the user.
VehicleProfileService
  • /v1/vehicle/profile/list
  • /v1/vehicle/profile/{id}
  • /v1/vehicle/profile/description-files/a2l
  • /v1/vehicle/profile/seedkey/list
  • /v1/vehicle/profile/seedkey/{id}
  • /v1/vehicle/profile/version/{version-id}
  • /v1/vehicle/profile/description-files/a2l/{id}
  • /v1/vehicle/profile/{id}/ecu/a2l
  • /v1/vehicle/profile/{id}/ecu/a2l/list
  • GET
  • GET
  • GET POST
  • GET
  • GET
  • GET
  • PUT
  • GET PUT
  • GET
A set of services related to vehicle profiles.
VehicleService
  • /v1/vehicle/info
  • /v1/vehicle/labels
  • /v1/vehicle/plate
  • /v1/vehicle/vin
  • /v1/vehicle/wcu
  • /v1/vehicle/label/{label}
  • /v1/vehicle/labels/{vin}
  • /v1/vehicle/plate/{plate}
  • /v1/vehicle/position/wcu
  • /v1/vehicle/search/vins
  • /v1/vehicle/vin/{vin}
  • /v1/vehicle/wcu/comment
  • /v1/vehicle/wcu/connected
  • /v1/vehicle/wcu/info
  • /v1/vehicle/wcu/name
  • /v1/vehicle/wcu/shelve
  • /v1/vehicle/wcu/software_version
  • /v1/vehicle/wcu/state
  • /v1/vehicle/wcu/unshelve
  • /v1/vehicle/{vin}/comment
  • /v1/vehicle/{vin}/plate
  • /v1/vehicle/connected/car/{vin}
  • /v1/vehicle/connected/now/cars
  • /v1/vehicle/connected/value/cars
  • /v1/vehicle/connected/wcu/{wcu_id}
  • /v1/vehicle/diagnostics/{vin}/signaling-synchronous-diagnostic-session
  • /v1/vehicle/diagnostics/{vin}/synchronous-diagnostic-session
  • /v1/vehicle/history/car/{vin}
  • /v1/vehicle/history/wcu/{wcu-id}
  • /v1/vehicle/labels/{vin}/remove
  • /v1/vehicle/last_upload/car/{vin}
  • /v1/vehicle/last_upload/wcu/{wcu_id}
  • /v1/vehicle/position/car/{vin}
  • /v1/vehicle/position/wcu/{wcu-id}
  • /v1/vehicle/search/vins/matching
  • /v1/vehicle/wcu/module/gps
  • /v1/vehicle/wcu/refurbish/finalize
  • /v1/vehicle/wcu/refurbish/initiate
  • /v1/vehicle/wcu/{object_id}/id
  • /v1/vehicle/wcu/{wcu_id}/assignment
  • /v1/vehicle/diagnostics/{vin}/synchronous-diagnostic-session/disable
  • /v1/vehicle/diagnostics/{vin}/synchronous-diagnostic-session/enable
  • GET POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET PUT
  • GET
  • GET
  • POST
  • GET
  • GET POST PUT
  • GET
  • GET
  • GET
  • POST
  • GET
  • GET
  • POST
  • GET PUT
  • PUT
  • GET
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • PUT
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • POST
  • GET
  • GET
  • PUT
  • PUT
A set of endpoints that concerns a vehicle.

Data Types

JSON

type description
A2LDescriptionFile Metadata for an a2l file.
A2LSignalSource Signal source for A2L files.
Accepted
ActiveSignalSource Signal source for active signals.
Area5AssignmentInfo
Assignment Describes an assignment which is the actual entity on a car.

The relation between a task and assignment is mainly that a task can consist of multiple assignments running on a set of cars. If a task is associated with only one car, the task and assignment are essentially the same thing.

AssignmentAccessType
AssignmentIdentifier
AssignmentInfo
AssignmentResult Models the results returned when listing available assignments.
AssignmentType The different assignment types available.
AvailableSignals Lists available signals for a signal source.
BasicSignalSource
CANBusMapping Describes how each CAN bus name in a haf file should be rewritten.
E.g CAN1 in the haf file should be replaced with CAN3.
CarConnectedValue Describes the time in minutes since the vehicle identified by the vin last communicated with the WICE backend services.
CarRights A set of assigned permissions for a user on a car identified by its VIN.
CompilationAccepted
CompileInternal
CompileOptions
CompilePath
CompileType
ConnectionEventType Models the connection event types for a unit.
CopyAssignmentAccepted
DREC
DRECType
DateReference
DiagnosticRequestType
DiagnosticResponse A diagnostic response for a specific ECU at a specific time.
EcuA2LAssociationBase
EcuA2lAssociation
EcuA2lAssociationResult Models an existing ECU to A2L file association
EcuA2lAssociationSummary Describes the number of associated A2L files for a particular ECU and CAN bus.
EcuSignalSource Template for signal sources for a specific ECU.
EcuToDescriptionFileAssociation
FileIdentifiers
FlexraySignalSource Signal source for a specific Flexray bus.
IDCAssignmentInfo
IncludeModuleNames
Label Models a label and any associated value.
LabelCriteria
LabelMatch Models how the provided labels should match (all, any or none) when searching resources by labels.
LabelMatchOperator
LabelSearch
LabelSearchOperator
LabelString
LatestResultFile
MeasurementSetup
ModuleInfo
ModuleNames The following enumerator is used to control whether downloaded MDF files should retain module names or be removed in cases where a module name is present. The following options are available:
  • KEEP_AS_IS, keep the files as they are. I don't care about it.
  • WITH, retain module names for those having module names. For files not having any module names we cannot invent them.
  • WITHOUT, remove module names for files having them.
ModuleType
OBD2SignalSource
PagedResult
PartialResult
PassiveCanSignalSource Signal source for a specific CAN bus.
PassiveLinSignalSource Signal source for a specific LIN bus.
Position
PositionSearch
PositionSearchResults
Recorder
RecorderType
ReferencedECUAssociations
ResourceConnectionEvent
ResourceGroupMemberPeriod
ResourceGroupMembersHistory Models the WCUs that have belonged to a resource group.
ResultFile Describes a set of result files produces by a task.
ResultFileDate A summary of the number of files and their total size for a measurement date.
ResultFileDate_v2
ResultFileIdentifier
ResultFileResourceGroup Models the resource group the Vehicle was part of during the measurement.
ResultFileTypeTuple Valid tuples:
[text,text_common_timebase or text_different_timebase or text_subtype_any]
[mdf, mdf_without_module_names or mdf_with_module_names or any_subtype]
[vector, vector_frame_id/vector_frame_names]
[canrecorder, no_subtype]
[signalreader, no_subtype]
[soh, no_subtype]
[idc, no_subtype]
[log, no_subtype]
[raw, no_subtype]
[unknown, no_subtype]
[etas, no_subtype]
[zip, no_subtype]
[text, no_subtype]
[video, webm, quicktime or mp4]
[audio, pcm, g711 or gsm]
[text, json]
[pcap, no_subtype]
[ziprt, no_subtype]
[md5, no_subtype]
[text, no_subtype]
ResultFile_v2
SRECSignal
SearchParameters 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.
SearchResult
SeedKey
SequenceFileData
ServerTrigger Server triggers are triggers that are evaluated when new measurement data reaches the server.
If a trigger expression is evaluated to true, a label, specified by the user, is placed on the data-file."
ServerTrigger
ServiceMapper
Signal
SignalName
SignalReaderAssignmentInfo
SignalSource
SignalSourceType The different signal source types that might be available for an assignment.
SignalType
SohDiagnosticOption The different diagnostic options available for creating an SoH task
SohReadECUDTC
SortOrder
SpecificModuleSignalSource Template for a signal source of a specific type and module.
Status An assignment typically has a status, or state. When not started the status is Pending which hopefully later will change to Running. When an assignment is done its status changes to Stopped.

Currently, the set of statuses are (name, value):

  • Pending, 0 - The user has created an assignment but the car is not yet aware of it.
  • Downloaded, 1 - A state rarely seen but it signifies the fact that the car is aware of a new assignment but it has not yet been started.
  • Running, 2 - The car has successfully started the assignment. It does not imply that the assignment is running at this very moment, this depends on whether the car is actually started and is running. However, once the car is running the assignment will also be started.
  • Error, 3 - The WCU in the car could not for some reason start the assignment. The reason for this state can be communicated via a status message.
  • Stopped, 4 - The assignment has been stopped and will not be started once the car is running. This is the final state for an assignment.
  • Stop pending, 5 - Before the car is aware of that an assignment should be stopped, the intermediate status is Stop pending. This status is the result of either starting a new assignment of the same type or that the user has ordered to stop the current assignment.
  • Warning, 6 - A state that signifies that something is wrong but not to the extent that an assignment can not be run.
StatusMessage A status message with a response code and optional message. This is usually returned upon an unsuccessful call.
Task A task is a general term that defines that something is performed on a set of cars on behalf of a user.

A task can be some kind of measurement assignment (MCD-Hub, Signal Reader, ..) or an ECU software update (SWDL). Also, a task can be started on one or more cars. A task on a specific car is called an assignment.

TaskInfo
TaskSearchParameter
TaskSearchResult
TaskSubject Describes general info related to a WCU
Task_v2 A task is a general term that defines that something is performed on a set of cars on behalf of a user.

A task can be some kind of measurement assignment (MCD-Hub, Signal Reader, ..) or an ECU software update (SWDL). Also, a task can be started on one or more cars. A task on a specific car is called an assignment.

Task_v3 Like Task_v2 but the results are an array of ResultFile_v2 which describes each result file in the results.
Tasks A map with one key (which uniquely identifies a task) per created task - each task is associated with one subject wcu except for strict Resource Groups where the task is shared by the group.
Trigger
Type
Type
UDSignalSource
UploadFilesResult Maps each uploaded file to an unique UUID which must be used when defining filePins for create Software Download tasks.
UserLogin
ValidationError A JSON describing the errors when a WCU does not validate with the task settings when creating a new task.
VbfFilePin Describes what PIN code goes with which VBF files. All file identifiers used must have been uploaded beforehand.
Vehicle The attributes that can be found for a vehicle (car).
VehicleDescriptionFile General attributes of a vehicle description file.
VehicleDescriptionFileResultOfA2LDescriptionFile
VehicleInfo Describes general info related to a Vehicle
VehicleLatestResultFile
VehiclePosition A position for a specific vehicle.
VehicleProfile
VehicleProfileIdentifier
VehicleProfileResult
VehicleProfileVersion
VehicleProfileVersion
VinLabelAssociation Models the labels currently associated to a vehicle identified by the VIN.
WCU A task is a general term that defines that something is performed on a set of cars on behalf of a user.

A task can be some kind of measurement assignment (MCD-Hub, Signal Reader, ..) or an ECU software update (SWDL). Also, a task can be started on one or more cars. A task on a specific car is called an assignment.

WCUCertificateData Information about the current certificate on the WCU.
WCUInfo Describes general info related to a WCU
WMUSignalSource Signal source for a specific WMU ID.
WcuState
WiceSignalSource