Obtenir un historique de rapport

GET
https://api.digicert.com/reports/v1/report/history

Appelez ce point de terminaison pour obtenir tous les rapports dont la génération est actuellement planifiée.

La fonction de bibliothèque de rapports doit être activée sur votre compte pour obtenir une réponse de ce point de terminaison.

cURL
curl -X GET \
  'https://www.digicert.com/services/v2/reports/preview/report/history' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'
Python
import requests

url = "https://www.digicert.com/services/v1/reports/preview/reporth/history"

payload={}
headers = {
  'Content-Type': 'application/json',
  'X-DC-DEVKEY': {{api_key}},
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
Go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://www.digicert.com/services/v1/reports/preview/report/history"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("X-DC-DEVKEY", {{api_key}})

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
NodeJS
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://www.digicert.com/services/v1/reports/preview/report/history',
  'headers': {
    'Content-Type': 'application/json',
    'X-DC-DEVKEY': {{api_key}},
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
204 No Content
{
    "page": {
        "total": 1,
        "limit": 1,
        "offset": 0
    },
    "report_history": [
        {
            "report_display_name": "RPT01",
            "report_identifier": "52150de8-3c97-4802-bc18-e419d2c713fc",
            "report_run_identifier": "84604797-430a-470a-bb0d-156de649b92c",
            "created_by_user_id": 10192344,
            "created_by_user_name": "Abhijeeta Mohanty",
            "created_date": "2021-01-13 02:15:48",
            "report_type": "orders",
            "report_type_display_name": "Orders",
            "report_start_date": "2021-01-13 09:15:37",
            "report_end_date": "2021-01-13 09:15:48",
            "schedule": "WEEKLY", 
            "format": [
                "CSV" /
            ],
            "status": "READY"
        }
    ]
}
400 Invalid offset
{
    "code": "invalid_offset",
    "message": "Offset should be zero or positive integer"
}
400 Invalid limit
{
"code": "invalid_limit",
"message": "Limit should be positive integer"
}
401 Invalid user
{
"code": "user_authentication_error",
"message": "User is not authenticated."
}
403 Forbidden
{
    "code": "user_forbidden",
    "message": "User does not have the required permission."
}
403 Not enabled
{
    "code": "custom_reports_not_enabled",
    "message": "Custom reports is not enabled"
}

Paramètres de requête

Nom Obligatoire/facultatif Type Description
offset Facultatif integer Nombre total d’enregistrements à inclure dans la réponse. Doit être supérieur ou égal à 0 Valeur par défaut : 0.
limit Facultatif integer Nombre total de pages à inclure dans la réponse. Valeur par défaut : 100.
report_display_name Facultatif string Nom du rapport affiché. S'il y a plusieurs noms, les séparer par des virgules.
schedule Facultatif string Fréquence de la création de rapport. Valeurs possibles : ON_DEMAND, WEEKLY, MONTHLY.
status Facultatif string État du rapport. Tous les rapports planifiés sont indiqués ACTIVE.
report_type Facultatif string Type de rapport.
search Facultatif string Terme à utiliser en tant que filtre de la recherche. La fonction prend en charge les recherches partielles.
sort_by Facultatif string Paramètre sur lequel le tri sera effectué. Paramètres pris en charge pour le tri : report_display_name, report_type, schedule, format. Si aucun paramètre sort_by n’est fourni, le paramètre par défaut est report_start_date.
sort_direction Facultatif string Le tri peut se faire dans l’ordre ASC (ascendant) ou DESC (descendant). La valeur par défaut est ASC, sauf si la colonne de tri et sort_direction sont tous deux laissés vide. Dans ce dernier cas, le tri sera fait selon le paramètre report_start_date (colonne de tri par défaut) et par ordre DESC.

Paramètres de réponse

Nom Type Description
page object Conteneur
.. total integer Nombre de rapports dont la génération est planifiée.
.. limit integer Nombre total de pages à inclure dans la réponse. Valeur par défaut : 100.
.. offset integer Nombre total d’enregistrements à inclure dans la réponse. Doit être supérieur ou égal à 0 Valeur par défaut : 0.
report_history container Conteneur.
.. report_display_name string Nom du rapport affiché. S'il y a plusieurs noms, les séparer par des virgules.
.. report_identifier string Identifiant de rapport affiché dans la réponse de l’API Créer un rapport.
.. report_run_identifier string Identifiant associé à la génération du rapport. Cette valeur est affichée dans l’API Créer un rapport.
.. created_by_user_id string Identifiant utilisateur associé à la personne créant le rapport.
.. created_date string Date de création du rapport, avec horodatage au format suivant : AA-MM-JJ HH--MM-SS.
.. created_by_user_name string Nom d’utilisateur DigiCert associé à la création du rapport.
.. report_type string Type de rapport. Consultez la page API Répertorier les types de rapports pris en charge pour de plus amples informations.
.. report_type_display_name string Nom spécifié comme type de rapport.
.. report_start_date date Date de démarrage pour la création du rapport. Format : AA-MM-JJ.
.. report_end_date date Date de fin pour la création du rapport. Format : AA-MM-JJ.
.. schedule string Fréquence de la création de rapport. Valeurs possibles : ON_DEMAND, WEEKLY, MONTHLY.
.. format string Format du rapport. Pour ce point de terminaison, la seule valeur possible est CSV Pour renvoyer un rapport en JSON, reportez-vous à la page API Obtenir un rapport JSON.
.. status string État du rapport. Les valeurs autorisées sont GENERATING, READY, FAILED, SCHEDULED.
.. manually_triggered boolean Indique si le rapport est généré manuellement ou par le système.