Registri di report

Recupero di tutti i report

Richiesta

Definizione

GET /api/v1/reports/registries

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.
creation_status	string	No	Filtra i risultati il cui stato di creazione corrisponde a quello inserito.
id	integer	No	Filtra i risultati relativi all'ID inserito.
id_list	array<string>	No	Filtra i risultati relativi a uno degli ID contenuti nella lista inserita.
report_schedule_id	string	No	Filtra i risultati relativi all'ID della pianificazione inserito.
report_schedule_id_list	array<string>	No	Filtra i risultati relativi a uno degli ID delle pianificazioni contenuti nella lista inserita.
scheduled_by	string	No	Filtra i risultati relativi all'utente che ha creato il report.
type	string	No	Filtra i risultati relativi al tipo di report inserito.

Risposta

Codici di stato

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

Corpo

Attributi

• data.registries.created_at integer

  Data di creazione del report in formato UNIX (microsecondi).

• data.registries.creation_status string

  Indica lo stato di creazione del report.

• data.registries.hosts array<string>

  Host per cui è stato generato il report.

• data.registries.id string

  Codice identificativo del report.

• data.registries.report_schedule_id string

  Codice identificativo della pianificazione a cui è associato il report.

• data.registries.scheduled_by string

  Nome dell'utente che ha creato il report.

• data.registries.start_timestamp integer

  Data e ora in cui il report è stato avviato in formato UNIX (microsecondi).

• data.registries.timezone string

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

• data.registries.type string

  Tipo di report.

Esempio

{
"data": {
    "registries": [
    {
        "created_at": 1705497089045145,
        "creation_status": "in_progress",
        "end_timestamp": 1681941600000000,
        "hosts": [
        "www.service-test-host.it"
        ],
        "id": "e8xx17f7-xxxx-46d7-xxxx-2bxx46xxxc38",
        "report_schedule_id": "4xx33x86-xxxx-4bab-xxxx-baxxdxxx4461",
        "scheduled_by": "test_user",
        "start_timestamp": 1681855200000000,
        "timezone": "Europe/Rome",
        "type": "generic"
    }
    ]
},
"message": "List of report registries",
"pagination": {
    "first": 1,
    "last": 1,
    "page": 0,
    "total_count": 1,
    "total_pages": 1
},
"status": "ok"
}

Recupero di uno specifico report

Richiesta

Definizione

GET /api/v1/reports/registries/{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 registry retrieved"
400	"Error retrieving registry"
400	"Error with pagination fields"
403	"Forbidden"

Corpo

{
  "data": {
    "registry": {
      "created_at": 1705497089722671,
      "creation_status": "in_progress",
      "end_timestamp": 1681941600000000,
      "hosts": [
        "www.service-test-host.it"
      ],
      "id": "e8xx17f7-xxxx-46d7-xxxx-2bxx46xxxc38",
      "report_schedule_id": "4xx33x86-xxxx-4bab-xxxx-baxxdxxx4461",
      "scheduled_by": "test_user",
      "start_timestamp": 1681855200000000,
      "timezone": "Europe/Rome",
      "type": "generic"
    }
  },
  "message": "Report registry retrieved",
  "status": "ok"
}

Eliminazione di più registri

Richiesta

Definizione

DELETE /api/v1/reports/registries

Header

• Authorization richiesto

  Token di autenticazione con privilegi di lettura della risorsa.

  Bearer {token}

Corpo della richiesta

{
  "registry_ids": [
    "5fxxx011-xxxx-4c59-xxxx-a31xxx3bxxe5"
  ]
}

Risposta

Codici di stato

Codice di stato	Messaggio
200	"Report registries succesfully deleted"
400	"Error deleting report registries"
403	"Forbidden"

Corpo

{
  "message": "Report registries succesfully deleted",
  "status": "ok"
}