Alvos do alarme

• Listar
• Criar e atualizar

Listar

Endpoint que lista todos os alvos de um alarme.

Parameters

alarm_id: 1 (integer, required) - "Filtra alvos do alarme pelo ID do alarme."

Response quando os targets são dynamic_entities true

{success} Response 200 (application/json)

{
  "items": [
    {
        "alarm_id": 1,
        "targets": [
            {
                "id": 1,
                "name": "Energia Fronteira",
                "targetType":{
                    "id": 1,
                    "name": "Template",
                    "slug": "template",
                    "dataEntity":{
                        "id": 1,
                        "name": "Equipment"
                    }
                }
            },
            {
                "id": 2,
                "name": "Energia Setorizada",
                "targetType":{
                    "id": 1,
                    "name": "Template",
                    "slug": "template",
                    "dataEntity":{
                        "id": 1,
                        "name": "Equipment"
                    }
                }
            }
        ]
    }
  ]
}

Response quando os targets são dynamic_entities false

{success} Response 200 (application/json)

{
  "items": [
    {
        "alarm_id": 2,
        "targets": [
            {
                "id": 3,
                "name": "Equipamento",
                "targetType":{
                    "id": 2,
                    "name": "Equipamentos",
                    "slug": "equipments",
                    "dataEntity":{
                        "id": 1,
                        "name": "Equipment"
                    }
                }
            }
        ],
        "equipments": [
            {
                "id": 1,
                "name": "Equipamento A"
            },
            {
                "id": 2,
                "name": "Equipamento B"
            }
        ]
    }
  ]
}

{
  "items": [
    {
        "alarm_id": 3,
        "targets": [
            {
                "id": 4,
                "name": "Empresa",
                "targetType":{
                    "id": 3,
                    "name": "Empresas",
                    "slug": "companies",
                    "dataEntity":{
                        "id": 2,
                        "name": "Company"
                    }
                }
            }
        ],
        "companies": [
            {
                "id": 1,
                "name": "Empresa A"
            },
            {
                "id": 2,
                "name": "Empresa B"
            }
        ]
    }
  ]
}

{primary} Response 204 (application/json)

Quando os critérios de parâmetros não contiver registros a serem retornados.

{warning} Response 422 (application/json)

{
    "alarm_id": [
        "O campo alarm id selecionado é inválido."
    ],
    "alarm_target_id": [
        "O campo alarm target id selecionado é inválido."
    ]
}

Criar e atualizar

Endpoint que cria e atualiza os alvos de um alarme.

Attributes quando os targets são dynamic_entities true

alarm_id: 1 (integer, required) - "ID do alarme"
targets: [1,2] (array[integer], required) - "Alvos do alarme quando dynamic_entities for true"

Attributes quando o target é dynamic_entities false

alarm_id: 1 (integer, required) - "ID do alarme"
targets: [3] (array[integer], required) - "ID do alvo quando dynamic_entities for igual a false"
equipmets: [1,2] (array[integer], required) - "ID's de equipamentos"

alarm_id: 1 (integer, required) - "ID do alarme"
targets: [4] (array[integer], required) - "ID do alvo quando dynamic_entities for igual a false"
companies: [1,2] (array[integer], required) - "ID's de empresas"

Response

{success} Response 200 (application/json)

{warning} Response 422 (application/json)

{
    "alarm_id": [
        "O campo alarm id é obrigatório.",
        "O campo alarm id selecionado é inválido."
    ],
    "targets": [
        "O campo alarm id é obrigatório.",
        "Os targets de um alarme precisam ter o mesmo valor do campo dynamic entities"
    ],
    "targets.0": [
        "O campo targets.0 selecionado é inválido."
    ],
    "equipments":[
        "O campo equipments não pode ser utilizado com o campo companies."
    ],
    "companies":[
        "O campo empresas não pode ser utilizado com o campo equipments."
    ]
}

{warning} Response 400 (application/json)

Quando ocorre algum erro.