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.