graphs

Atualiza um Gráfico.

put/v1/reports/graphs/{_id}

Request

  • Base URL: http://localhost:8888/api
  • URL: http://localhost:8888/api/v1/reports/graphs/{_id}
  • Auth: API key in header x-api-key

Path parameters

ID do Gráfico.

Request body

namestring required

Nome do Gráfico

activeboolean

Status do Gráfico

orderinteger

Ordem do Gráfico

keystring

Key do Gráfico

param_key'candidates' | 'vacancies' required

Key da Dashboard Pai

Example request

{
  "name": "My Graph",
  "active": true,
  "order": 1,
  "key": "my-graph"
}

Response

Sucesso de Retorno!

_idstring

ID do Gráfico

keystring

Key do Gráfico

namestring

Título do Gráfico

param_keystring

Define a Dashboard pai

activeboolean

Define se a gráfico está ativo.

orderinteger

Ordem do Gráfico

enabledboolean

Gráfico está habilitado no plano.

plansstring[]

Lista de planos que o gráfico possui

Example response

{
  "_id": "636baff4c4984127856d2f63",
  "key": "meu-grafico-legal",
  "name": "Meu Gráfico Legal",
  "param_key": "candidates",
  "active": true,
  "order": 1,
  "enabled": true,
  "plans": [
    "free",
    "premium",
    "admin"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.