GRgroupe-psa
Monitors

Get the monitor by monitor Id.

Returns information about a specific Monitor for a given fleet.

get/fleets/{fid}/monitors/{mid}

Request

Path parameters

fidstring required

Resource is related to this fleet ID only.

midstring required

id of the monitor.

Response

Monitor response

createdAtstring date-time required

Date when the resource has been created.

updatedAtstring date-time required
monitorIdstring required

Uniq monitor ID returned when the monitor was created succefully.

status'Running' | 'Paused' | 'Failed' required

Example response

{
  "_links": {
    "self": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    },
    "fleet": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    }
  },
  "monitor": {
    "subscribeParam": {
      "retryPolicy": {
        "retryNumber": 10,
        "retryDelay": 60
      },
      "callback": {
        "webhook": {
          "target": "https://my.post.callback",
          "name": "My_Webhook",
          "attributes": [
            {
              "type": "Header",
              "key": "X-Vehicle_Id",
              "value": "$vin"
            }
          ]
        }
      },
      "refreshEvent": 120
    },
    "triggerParam": {
      "triggers": [
        {
          "zone": {
            "transition": "Out",
            "place": {
              "radius": 20,
              "center": {
                "longitude": 2.333333,
                "latitude": 48.866667
              }
            }
          },
          "time": {
            "times": [
              {
                "recurrence": "Daily",
                "start": "PT8H30M",
                "duration": "PT7H30M",
                "occurence": [
                  "Mon",
                  "Tue",
                  "Thu",
                  "Fri"
                ]
              }
            ],
            "timeZone": "Europe/Paris"
          },
          "data": {
            "data": "vehicle.energy.electric.level",
            "op": "greaterThan",
            "value": [
              "75"
            ]
          }
        }
      ],
      "boolExp": "((z1 & t1) | (z2 & !t1) | (f & z1) | (a & (z1|t))  | (o & (z1 | z2)))"
    }
  }
}

Changes

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