Filtros de Relatório

Step 1

Endpoint que o grupo de campos de Entidades.

Method URI Headers Authorization
GET /api/v3/reports-filters Content-Type: application/json Authorization: Bearer {token}


Response

{success} Response 200 (application/json)

{
  "steps": {
    "current": {
      "required_fields": []
    },
    "next": {
      "required_fields": [
        "entity"
      ]
    }
  },
  "entity_fields": {}
}

Detalhes dos campos

{primary} Response 204 (application/json). Quando os critérios de parâmetros não contiver registros a serem retornados.

Step 2

Endpoint do grupo de campos Tipo de Entidades.

Method URI Headers Authorization
GET /api/v3/reports-filters Content-Type: application/json Authorization: Bearer {token}

Request

{
  "entity": "company"
}

Attributes

entity: "company" (required, string) - "Entidade"

Response

{success} Response 200 (application/json)

{
  "steps": {
    "current": {
      "required_fields": [
        "entity"
      ]
    },
    "next": {
      "required_fields": [
        "entity",
        "type_measurement"
      ]
    }
  },
  "entity_type_fields": {}
}

Detalhes dos campos:

{primary} Response 204 (application/json). Quando os critérios de parâmetros não contiver registros a serem retornados.

Step 3

Endpoint que retorna o restante do filtro.

Method URI Headers Authorization
GET /api/v3/reports-filters Content-Type: application/json Authorization: Bearer {token}

Request

{
  "entity": "company",
  "type_measurement": "energy"
}

Attributes

entity: "company" (required, string) - "Entidade"
type_measurement: "energy" (required, string) - "Slug do tipo de medição"

Response

{success} Response 200 (application/json)

{
  "steps": {
    "current": {
      "required_fields": [
        "entity",
        "type_measurement"
      ]
    },
    "next": {
      "required_fields": []
    }
  }
}

Detalhes do filtro:

{primary} Response 204 (application/json). Quando os critérios de parâmetros não contiver registros a serem retornados.