Sign in

v1

latestOpenAPI 3.0.02026-07-24900287.5 KB
Parameters

Update a parameter

Update a parameter. Currently only parameters with the "Custom" parameter type can be updated.

patch/parameters/{id}

Path parameters

idstring required

Parameter Id

Request body

namestring
calculationstring

Equation that defines how this parameter will be calculated

unit_type'' | 'count' | 'distance' | 'duration' | 'percentage' | 'speed' | 'weight'

The type of units that will be used to display this parameter. Empty string indicates arbitrary units, for example player load.

ctr_ordernumber

Position of this parameter in CTR report

Example request

{
  "name": "Low Velocity running distance",
  "calculation": "$velocity_band1_total_distance+$velocity_band2_total_distance",
  "unit_type": "distance",
  "ctr_order": 123
}

Response

Updated parameter

idstring uuid required
parameter_type_idstring uuid required
namestring required
original_namestring required
base_namestring
bandnumber nullable
aggregationstring
group_bystring
slugstring required
unit_type'' | 'count' | 'distance' | 'duration' | 'percentage' | 'speed' | 'weight'

The type of units that will be used to display this parameter. Empty string indicates arbitrary units, for example player load.

calculationstring

Equation that defines how this parameter will be calculated

ctr_ordernumber required

Position of this parameter in CTR report

created_atstring required
modified_atstring required

Example response

{
  "id": "40fcbc90-705f-4b7e-b0e6-ec00d123801a",
  "parameter_type_id": "106b321a-8484-11e2-97f1-53b3868817d9",
  "name": "Low Velocity running distance",
  "original_name": "Low Velocity running distance",
  "base_name": "low_velocity_running_distance",
  "band": 1,
  "aggregation": "sum",
  "group_by": "total",
  "slug": "low_velocity_running_distance",
  "unit_type": "distance",
  "calculation": "$velocity_band1_total_distance+$velocity_band2_total_distance",
  "ctr_order": 123,
  "created_at": "2023-10-31 23:59:59",
  "modified_at": "2023-10-31 23:59:59"
}