Récupérer un rapport d'interrogation/de champ de surveillance (REST)

Ce cas d'utilisation décrit les exigences pour récupérer une interrogation de surveillance ou un rapport de terrain à l'aide de Broadsign Control API via REST.

Note : Les numéros d'identification que nous utilisons dans ces échantillons sont fournis à titre d'illustration. Ils ne sont pas valides. Assurez-vous d’utiliser vos propres numéros d’identification pour vos intégrations. De plus, dans nos exemples, nous utilisons le point de terminaison api-sandbox et le jeton HTTP.

Selon votre cas d’utilisation, utilisez l’une des méthodes suivantes :

  • Pour récupérer l'état de l'interrogation de tous les lecteurs et serveurs périphériques de votre domaine, utilisez GET et la méthode /monitor_poll/v2.
  • Pour récupérer l'état de l'interrogation d'un lecteur ou d'un serveur Edge spécifique sur votre domaine, utilisez GET et la méthode /monitor_poll/v2/by_client_resource_id.
  • Pour récupérer le rapport de terrain d'un lecteur ou d'un serveur Edge spécifique sur votre domaine, utilisez GET et la méthode /field_report/v4.

Pour récupérer l'état de l'interrogation de toutes les ressources de votre domaine, vous n'aurez besoin que de votre numéro d'identification de domaine.

Copier 
curl -X GET 
    'https://api-sandbox.broadsign.com:10889/rest/monitor_poll/v2?not_modified_since=2017-05-05T20%3A00%3A53Z&domain_id=123456789' 
        -H 'authorization: Bearer YourAPIKeyHere' 
        -H 'cache-control: no-cache'
Copier 
{
    "not_modified_since": "2017-10-27T20:05:43Z",
    "monitor_poll": [
    {
        "client_resource_id": 319,
        "domain_id": 123456789,
        "id": 3,
        "monitor_status": 2,
        "poll_last_utc": "2017-10-23T19:55:06",
        "poll_next_expected_utc": "2017-10-23T20:31:11",
        "private_ip": "192.168.1.200",
        "product_version": "12.1.0",
        "public_ip": "192.168.1.200"
        }
    ]
}

Pour récupérer l'état de l'interrogation de ressources spécifiques sur votre domaine, vous aurez besoin de leurs numéros d'identification uniques.

Copier 
curl -X GET 
    'https://api-sandbox.broadsign.com:10889/rest/monitor_poll/v2/by_client_resource_id?client_resource_id=13501&domain_id=123456789' 
    -H 'authorization: Bearer YourAPIKeyHere' 
    -H 'cache-control: no-cache'
Copier 
{
    "not_modified_since": "2017-10-27T19:57:02Z",
    "monitor_poll": [
        {
        "client_resource_id": 13501,
        "domain_id": 123456789,
        "id": 5,
        "monitor_status": 2,
        "poll_last_utc": "2017-10-26T14:33:41",
        "poll_next_expected_utc": "2017-10-26T15:15:26",
        "private_ip": "192.168.1.200",
        "product_version": "12.1.0-814",
        "public_ip": "192.168.1.200"
        }
    ]
}

Pour récupérer le rapport de terrain d'une ressource spécifique, vous aurez besoin de son identifiant unique ( target_resource_id ).

Copier 
curl -X GET
    'https://api-sandbox.broadsign.com:10889/rest/field_report/v4?not_modified_since=2017-05-05&domain_id=123456789&target_resource_id=13501' 
    -H 'authorization: Bearer YourAPIKeyHere' 
    -H 'cache-control: no-cache'

Note : Nous avons tronqué cette réponse pour les besoins de cet exemple.

Copier 
{
    "not_modified_since": "2017-10-27T20:00:53Z",
    "domain_id": 123456789,
    "field_report": "...",
    "field_report_submitted_utc": "...",
    "id": 4,
    "player_capability_report": "...",
    "player_capability_report_submitted_utc": "2017-10-16T20:00:53Z",
    "target_resource_id": 13501
}