Pianificazione report

Recupero di tutte le pianificazioni

Richiesta

Definizione

GET /api/v1/reports/schedules

Header

• Authorization richiesto

  Token di autenticazione con privilegi di lettura della risorsa.

  Bearer {token}

Parametri query string

Parametro	Tipo	Richiesto	Descrizione
paginate	boolean	Si	Indica se il risultato debba essere paginato.
page	integer	Si se paginate è true	Indice della pagina.
page_size	integer	Si se paginate è true	Numero di elementi visualizzati per pagina.
id	integer	No	Filtra i risultati relativi all'ID della pianificazione inserito.
id_list	array<string>	No	Filtra i risultati relativi agli ID delle pianificazioni contenuto nella lista inserita.
name	string	No	Filtra i risultati il cui nome della pianificazione corrisponde interamente o parzialmente alla stringa inserita.
type	string	No	Filtra i risultati il cui tipo di pianificazione corrisponde a quello inserito.
schedule	string	No	Filtra i risultati relativi alla frequenza di esecuzione del report specificata.
scheduled_at_start	integer	No	Filtra i report che sono stati pianificati dopo la data inserita.
scheduled_by_end	integer	No	Filtra i report che sono stati pianificati prima della data inserita.
scheduled_by	string	No	Filtra i risultati il cui utente specificato in scheduled_by corrisponde a quello inserito.

Risposta

Codici di stato

Codice di stato	Messaggio
200	"List of report schedules"
400	"Error with pagination fields"
403	"Forbidden"

Corpo

Attributi

• data.registries.name string

  Nome della pianificazione del report.

• data.registries.id string

  Codice identificativo della pianificazione del report.

• data.registries.hosts array<string>

  Host per cui è stato richiesto il report.

• data.registries.end_timestamp integer

  Data dell'ultima esecuzione del report in formato UNIX (microsecondi).

• data.registries.start_timestamp integer

  Data della prima esecuzione del report in formato UNIX (microsecondi).

• data.registries.scheduled_by string

  Nome dell'utente che ha creato la pianificazione.

• data.registries.scheduled_at integer

  Data in cui la pianificazione è stata creata in formato UNIX (microsecondi).

• data.registries.schedule string

  Frequenza di creazione pianificata in formato UNIX (microsecondi).

• data.registries.type string

  Tipo di report pianificato.

• data.registries.send_to array<string>

  Lista di indirizzi di posta elettronica a cui il report verrà inviato.

• data.registries.send_via string

  Metodo d'invio utilizzato per il report.

• data.registries.services array<string>

  Domain Group coinvolti nel report.

• data.registries.timezone string

  Timezone associata all'intervallo temporale per cui è stato creato il report.

Esempio

{
"data": {
  "schedules": [
    {
      "end_timestamp": null,
      "hosts": [
        "www.service-test-host.it"
      ],
      "id": "9fxx26xe-xxxx-49a5-xxxx-exxb9xxx9fx6",
      "name": "one_shot_generic",
      "schedule": "daily",
      "scheduled_at": 1705497135708315,
      "scheduled_by": "username",
      "send_to": [
        "test@test.it"
      ],
      "send_via": "email",
      "services": null,
      "start_timestamp": null,
      "timezone": "Europe/Rome",
      "type": "generic"
    }
  ]
},
"message": "List of report schedules",
"pagination": {
  "first": 1,
  "last": 1,
  "page": 0,
  "total_count": 1,
  "total_pages": 1
},
"status": "ok"
}

Recupero di una specifica pianificazione

Richiesta

Definizione

GET /api/v1/reports/schedules/{registry_id}

Headers

• Authorization richiesto

  Token di autenticazione con privilegi di lettura della risorsa.

  Bearer {token}

Risposta

Codici di stato

Codice di stato	Messaggio
200	"Report schedule retrieved"
400	"Error retrieving schedules"
400	"Error with pagination fields"
403	"Forbidden"

Corpo

{
  "data": {
    "schedule": {
      "end_timestamp": null,
      "hosts": [
        "www.service-test-host.it"
      ],
      "id": "407xxxab-xxxx-4b04-xxxx-7xxxcdxxa2x8",
      "name": "one_shot_generic",
      "schedule": "daily",
      "scheduled_at": 1705497139412776,
      "scheduled_by": "username",
      "send_to": [
        "test@test.it"
      ],
      "send_via": "email",
      "services": null,
      "start_timestamp": null,
      "timezone": "Europe/Rome",
      "type": "generic"
    }
  },
  "message": "Report schedule retrieved",
  "status": "ok"
}

Creazione di una pianificazione

Richiesta

Definizione

POST /api/v1/reports/schedules

Header

• Authorization richiesto

  Token di autenticazione con privilegi di lettura della risorsa.

  Bearer {token}

• Content-Type richiesto

  application/json

Corpo della richiesta

{
  "attrs": {
    "hosts": [
      "www.service-test-host.it"
    ],
    "name": "one_shot_generic",
    "schedule": "daily",
    "send_to": [
      "test@test.it"
    ],
    "send_via": "email",
    "timezone": "Europe/Rome",
    "type": "generic"
  }
}

Risposta

Codici di stato

Codice di stato	Messaggio
200	"Report schedule created succesfully"
400	"Error creating new schedule"
403	"Forbidden"

Corpo

{
  "data": {
    "schedule": {
      "end_timestamp": null,
      "hosts": [
        "www.service-test-host.it"
      ],
      "id": "09x04xx2-xxxx-48b5-xxxx-2x0xxx263xxf",
      "name": "one_shot_generic",
      "schedule": "daily",
      "scheduled_at": 1705497138483506,
      "scheduled_by": "username",
      "send_to": [
        "test@test.it"
      ],
      "send_via": "email",
      "services": null,
      "start_timestamp": null,
      "timezone": "Europe/Rome",
      "type": "generic"
    }
  },
  "message": "Report schedule created succesfully",
  "status": "ok"
}

Modifica una pianificazione

Richiesta

Definizione

PUT /api/v1/reports/schedules/{schedule_id}

Header

• Authorization required

  Token di autenticazione con privilegi di lettura della risorsa.

  Bearer {token}

• Content-Type required

  application/json

Corpo della richiesta

{
  "attrs": {
    "send_to": [
      "test@test.it",
      "test2@test.it"
    ],
    "send_via": "email"
  }
}

Risposta

Codici di stato

Codice di stato	Messaggio
200	"Report schedule updated succesfully"
400	"Error updating schedule"
403	"Forbidden"

Corpo

{
  "data": {
    "schedule": {
      "end_timestamp": null,
      "hosts": [
        "www.service-test-host.it"
      ],
      "id": "09x04xx2-xxxx-48b5-xxxx-2x0xxx263xxf",
      "name": "one_shot_generic",
      "schedule": "daily",
      "scheduled_at": 1705497136642579,
      "scheduled_by": "username",
      "send_to": [
        "test@test.it",
        "test2@test.it"
      ],
      "send_via": "email",
      "services": null,
      "start_timestamp": null,
      "timezone": "Europe/Rome",
      "type": "generic"
    }
  },
  "message": "Report schedule updated succesfully",
  "status": "ok"
}

Eliminazione di più pianificazioni

Richiesta

Definizione

DELETE /api/v1/reports/registries

Header

• Authorization richiesto

  Token di autenticazione con privilegi di lettura della risorsa.

  Bearer {token}

Corpo della richiesta

{
  "schedules_ids": [
    "09x04xx2-xxxx-48b5-xxxx-2x0xxx263xxf"
  ]
}

Risposta

Codici di stato

Codice di stato	Messaggio
200	"Schedules succesfully deleted"
400	"Error deleting report schedules"
403	"Forbidden"

Corpo

{
  "message": "Schedules succesfully deleted",
  "status": "ok"
}