Patch Training

Testing

PATCH

https://Example-Server.com/be/v1/trainings

Last modified:2025-10-10 13:19:15

This endpoint is used to update an existing app with specific training settings. The settings can include:

nTracesReliable: The amount of traces requred before a dataset is considered trustworthy and DxF processing starts. (For manual Trace processing and patches this value sets the amount of traces required to generate a DxF image where the untraced data is put to the end of the DxF image. Otherwise the untraced data goes to the front of the DxF image.)

minCoverage: The amount of data of the DxF image covered by traces until DxF processing starts in percent.

maxCoverage: The amount of data of the DxF image covered by traces until no more DxF images are produced.

minTraceTimeSec: The amount of time required to be covered by traces until DxF processing starts in seconds.

nProcessTracesMin: The required amount of collected traces to trigger automatic trace processing.

uploadTrace: A flag to enable or disable the collection of traces.

Request

Header Params

Body Params application/json

Example

{
    "appName": "{{appName}}",
    "nTracesReliable": 30,
    "minCoverage": 0.2,
    "maxCoverage": 0.6,
    "minTraceTimeSec": 1800,
    "nProcessTracesMin": 30,
    "uploadTrace": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://Example-Server.com/be/v1/trainings' \
--header 'x-rockit-beauth-token: eyjhvcIhvds;huVODV...' \
--header 'x-rockit-orgname: ExampleOrg' \
--header 'x-rockit-username: adminPrincipal' \
--header 'x-rockit-api-key: {{_adminPrincipal_apiKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appName": "sushi",
    "nTracesReliable": 30,
    "minCoverage": 0.2,
    "maxCoverage": 0.6,
    "minTraceTimeSec": 1800,
    "nProcessTracesMin": 30,
    "uploadTrace": true
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": "success",
    "message": "app modified"
}

🟠401Unauthorized

🟠400Invalid Param

Modified at 2025-10-10 13:19:15

Training Infos

Changelog