Remoção em massa

Listagem

Endpoint para listagem de dashboards por id da conta.


O campo account_id é obrigatório quando o usuário que estiver fazendo a requisição for um super admin.

Attributes

account_id: 1 (integer, required) - "Id da conta no qual os dashboards a serem deletados são relacionados."
Method URI Headers Authorization
GET /api/v3/dashboards Content-Type: application/json Authorization: Bearer {token}


Response

{success} Response 200 (application/json)

{
  "items": [
    {
      "id": 1,
      "name": "Medição",
      "entity_id": 2,
      "entity_type": "equipment",
      "entity": {
        "id": 1,
        "name": "Equipamento 1",
        "company": {
          "id": 1,
          "name": "Empresa 1"
        }
      }
    },
    {
      "id": 2,
      "name": "Sumário",
      "entity_id": 2,
      "entity_type": "equipment",
      "entity": {
        "id": 1,
        "name": "Equipamento 1",
        "company": {
          "id": 1,
          "name": "Empresa 1"
        }
      }
    },
    {
      "id": 3,
      "name": "Medição",
      "entity_id": 2,
      "entity_type": "company",
      "entity": {
        "id": 1,
        "name": "Empresa 1"
      }
    },
    {
      "id": 4,
      "name": "Medição",
      "entity_id": 4,
      "entity_type": "company",
      "entity": {
        "id": 1,
        "name": "Empresa 2",
        "company": {
          "id": 1,
          "name": "Empresa 1"
        }
      }
    },
    {
      "id": 5,
      "name": "Medição",
      "entity_id": 6,
      "entity_type": "equipment",
      "entity": {
        "id": 1,
        "name": "Empresa 2",
        "company": {
          "id": 1,
          "name": "Empresa 1"
        }
      }
    },
    {
      "id": 5,
      "name": "Medição",
      "entity_id": 7,
      "entity_type": "company",
      "entity": {
        "id": 1,
        "name": "Empresa 3"
      }
    }
  ]
}

Response

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

Response

{warning} Response 422 (application/json). Retornado quando o id da conta não for enviado por um usuário do tipo super admin


Remoção de dashboards

Endpoint para remoção de dashboards por id de dashboard e id de conta.

Method URI Headers Authorization
DELETE /api/v3/dashboards/ Content-Type:application/json Authorization: Bearer {token}

Attributes

ids: [1, 2, 3, 4] (array, required) - "Ids de dashboards."
account_id: 1 (integer, required) - "Id da conta no qual os dashboards a serem deletados são relacionados."


Body

{
  "ids": [
    1,
    2,
    3,
    4
  ],
  "account_id": 1
}

Response

{success} Response 200 (application/json)

Response

{primary} Response 204 (application/json) Quando o dashboard id enviado é válido porém o usuário tentando realizar a ação não tem permissão.

Response

{warning} Response 422 (application/json)

Body Response

{
  "account_id": [
    "O campo conta é obrigatório."
  ],
  "ids": [
    "O campo ids é obrigatório."
  ]
}

Response

{warning} Response 422 (application/json)

Body Response

{
  "ids.0": [
    "O campo ids.0 selecionado é inválido."
  ]
}