Skip to content

How to use ADT

Ekaterina Khlebushkina edited this page Aug 21, 2024 · 16 revisions

Quick Start

Working with cURL

API URI

https://api.adt.apps.bosch-engineering.com/v1

Generate the ID Token

You will need an ID Token for authenticating you requests in ADT.

Create file auth.json with the following content:

{"AuthParameters" : {"USERNAME" : "<your-email>", "PASSWORD" : "<password>"}, "AuthFlow" : "USER_PASSWORD_AUTH", "ClientId" : "<client-id>"}

In the same location as auth.json run the following script: get_token.sh:

./get_token.sh

Use the output key in your further Requests in ADT.

Get Channel List of a MF4 file

Download the request data template curl_channel_list.json.

curl -X POST --data @curl_channel_list.json \
-H "Content-Type: application/json" \
-H"Authorization: Bearer <IDToken>" \
https://api.adt.apps.bosch-engineering.com/v1

You will get the signal list of the MF4 file. Which could be used for the export quick start tutorial.

Export One Signal

Download the request data template curl_export_one_signal.json.

curl -X POST --data @curl_export_one_signal.json \
-H "Content-Type: application/json" \
-H"Authorization: Bearer <IDToken>" \
https://api.adt.apps.bosch-engineering.com/v1

You will find the exported parquet file of the chosen signal in the output folder.

With Postman

Download the Postman Quick Start Collection.

Prepare

Get the ID Token at first

image

You will find the ID Token in the AuthenticationResult.

Setup the ID Token in Postman Collection

  1. Click the collection name
  2. Click Variables tab.
  3. Input the ID Token.
image

Get Channel List of a MF4 file

Open the request "Quick Start Get Channels". Fill the needed fields. The input bucket must be the bucket that the cross account role has the access to. And then click "Send".

Screenshot 2024-08-21 at 21 12 53

You will get the signal list of the MF4 file. Which could be used for the export quick start tutorial.

Export one Signal

Open the request "Quick Start Export Signal". Fill the needed fields. The input and output bucket must be the buckets that the cross account role has the access to. And then click "Send".

Screenshot 2024-08-21 at 17 33 21

You will find the exported parquet file of the chosen signal in the output folder.

Want to know more about how to use ADT?

Checkout our Postman Collection

https://github.com/bosch-engineering/automotive_data_transformer_support/blob/main/adt_v1.postman_collection.json

OpenAPI Doc

https://github.com/bosch-engineering/automotive_data_transformer_support/blob/main/adt_openapi_v1.json

ADT Limitations

https://github.com/bosch-engineering/automotive_data_transformer_support/wiki/Limitations