List

This endpoint returns a complete list of chosen resources that can be used for select fields where necessary.

Templates

GET /api/v1/list/templates

Returns all the templates with their id and label field ordered alphabetically

Example request:

GET /api/v1/list/templates HTTP/1.1
Host: https://ccharts.hir.facts4.work/

Example response:

HTTP/1.1 200 OK
Content-type: application/json

{
    "data": [
        {
            "label": "a_template",
            "id": "12618492-27ed-4108-8398-479274adfd32"
        },
        {
            "label": "b_template",
            "id": "f562799a-1151-45f7-8f2d-d71ee79c9b8e"
        }
    ]
}
Query Parameters:
 
  • access_token (string) – valid access token for OAuth2 authentication
Response JSON Array of Objects:
 
  • id (string) – id of the template
  • label (string) – label of the template
Status Codes:

Metrics

GET /api/v1/list/metrics

Returns a list of final words of metric labels, refered to as metric in a template``s ``elements. These are order alphabetically and should be used when creating template.

Example request:

GET /api/v1/list/metrics HTTP/1.1
Host: https://ccharts.hir.facts4.work/

Example response:

HTTP/1.1 200 OK
Content-type: application/json

{
    "data": [
        "monoasc",
        "monodesc",
        "slowprocess"
    ]
}
Query Parameters:
 
  • access_token (string) – valid access token for OAuth2 authentication
Response JSON Array of Objects:
 
  • metric (string) – final part of a metric label
Status Codes:

Parts

GET /api/v1/list/parts

Returns a list of parts that are the initial words of metric label, refered to as part_id in a dashboard creation. These are order alphabetically and should be used when creating a dashboard from a template.

Example request:

GET /api/v1/list/parts HTTP/1.1
Host: https://ccharts.hir.facts4.work/

Example response:

HTTP/1.1 200 OK
Content-type: application/json

{
    "data": [
        "local.sample.",
        "local.measurement.",
        "local.params."
    ]
}
Query Parameters:
 
  • access_token (string) – valid access token for OAuth2 authentication
Response JSON Array of Objects:
 
  • part (string) – initial part of a metric label
Status Codes: