ExamTemplate

Saves changes to an existing indicator template.

Changed on
put/admin-api/v1/exam-template/indicator

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/admin-api/v1/exam-template/indicator
  • Auth: oauth (defined in the document in a form this page cannot read)

Query parameters

institutionIdinteger

Request body

idinteger

Indicator template identifier (PK). Not set on create.

examTemplateIdinteger

Identifier of the exam template this indicator template belongs to. Not set for indicator templates embedded in a full-create request.

namestring required

Name of the indicator shown in monitoring.

type'UNKNOWN' | 'LAST_PING' | 'ERROR_COUNT' | 'WARN_COUNT' | 'INFO_COUNT' | 'BATTERY_STATUS' | 'WLAN_STATUS' required

Indicator type.

colorstring

Default RGB color (hex, without leading '#') of the indicator.

iconstring

Default icon name of the indicator.

tagsstring

Comma-separated tags for log-based indicators.

Example request

{
  "id": 1,
  "examTemplateId": 1,
  "name": "Battery",
  "type": "BATTERY_STATUS",
  "color": "44a2c6",
  "thresholds": [
    {
      "value": 50,
      "color": "ff9800"
    }
  ]
}

Response

OK

idinteger

Indicator template identifier (PK). Not set on create.

examTemplateIdinteger

Identifier of the exam template this indicator template belongs to. Not set for indicator templates embedded in a full-create request.

namestring required

Name of the indicator shown in monitoring.

type'UNKNOWN' | 'LAST_PING' | 'ERROR_COUNT' | 'WARN_COUNT' | 'INFO_COUNT' | 'BATTERY_STATUS' | 'WLAN_STATUS' required

Indicator type.

colorstring

Default RGB color (hex, without leading '#') of the indicator.

iconstring

Default icon name of the indicator.

tagsstring

Comma-separated tags for log-based indicators.

Example response

{
  "id": 1,
  "examTemplateId": 1,
  "name": "Battery",
  "type": "BATTERY_STATUS",
  "color": "44a2c6",
  "thresholds": [
    {
      "value": 50,
      "color": "ff9800"
    }
  ]
}

Changes

  • 307d5ee03c39Revision changes
    • breaking

      the request property became required

    • info

      api operation id saveIndicatorPut removed and replaced with saveIndicatorTemplate

    • info

      api tag ExamTemplate added

    • info

      api tag exam-template-controller removed

    • info

      the response property became required for the status

  • 94fd325fcb6cRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status