Berichtshistorie abrufen

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

Verwenden Sie diesen Endpunkt, um alle Berichte abzurufen, deren Erstellung derzeit geplant ist.

Die Funktion „Berichtsbibliothek“ muss in Ihrem Konto aktiviert sein, damit dieser Endpunkt erfolgreich antworten kann.

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"
}

Abfrageparameter

Name Antr./Opt. Typ Beschreibung
offset optional integer Gesamtzahl der Datensätze, die in die Antwort aufgenommen werden sollen. Muss größer oder gleich 0 sein. Standard: 0.
limit optional integer Gesamtzahl der Seiten, die in die Antwort aufgenommen werden sollen. Standard: 100.
report_display_name optional string Der Name des angezeigten Berichts. Mehrere Berichtsnamen werden durch ein Komma getrennt.
schedule optional string Die Häufigkeit der Berichtserstellung. Mögliche Werte: ON_DEMAND, WEEKLY, MONTHLY.
status optional string Der Status des Berichts. Alle geplanten Berichte sind ACTIVE.
report_type optional string Der Typ des Berichts.
search optional string Der Begriff, der als Filter für die Suche verwendet werden soll. Teilweise Suchen werden unterstützt.
sort_by optional string Der Parameter, nach dem sortiert werden soll. Unterstützte Parameter für die Sortierung: report_display_name, report_type, schedule, format. Wenn kein sort_by-Parameter angegeben wird, ist der Standardwert report_start_date.
sort_direction optional string Richtung kann ASC (aufsteigend) oder DESC (absteigend) sein. Standard ist ASC,, es sei denn, sowohl die Sortierspalte als auch die sort_direction sind leer. In diesem Fall erfolgt die Sortierung nach report_start_date (Standardsortierspalte) in absteigender (DESC) Richtung.

Reaktionsparameter

Name Typ Beschreibung
page object Container
.. total integer Die Anzahl der Berichte, die erstellt werden sollen..
.. limit integer Gesamtzahl der Seiten, die in die Antwort aufgenommen werden sollen. Standard: 100.
.. offset integer Gesamtzahl der Datensätze, die in die Antwort aufgenommen werden sollen. Muss größer oder gleich 0 sein. Standard: 0.
report_history container Container.
.. report_display_name string Der Name des angezeigten Berichts. Mehrere Berichtsnamen werden durch ein Komma getrennt.
.. report_identifier string Berichts-ID, die in der Antwort der Create Report API angezeigt wird.
.. report_run_identifier string Die ID, die mit der Generierung des Berichts verknüpft ist. Dieser Wert wird in der Create Report API angezeigt.
.. created_by_user_id string Die Benutzer-ID, die mit der Person verbunden ist, die den Bericht erstellt.
.. created_date string Das Erstellungsdatum des Berichts, einschließlich des Zeitstempels im Format: JJ-MM-TT HH-MM-SS.
.. created_by_user_name string Der Digicert-Benutzername, der mit der Berichtserstellung verbunden ist.
.. report_type string Der Berichtstyp. Weitere Informationen finden Sie in der List supported report types API.
.. report_type_display_name string Der als Berichtstyp angegebene Name.
.. report_start_date date Das Startdatum für die Erstellung des Berichts. Format: JJ-MM-TT.
.. report_end_date date Das Enddatum für die Erstellung des Berichts. Format: JJ-MM-TT.
.. schedule string Die Häufigkeit der Berichtserstellung. Mögliche Werte: ON_DEMAND, WEEKLY, MONTHLY.
.. format string Das Format für den Bericht. Für diesen Endpunkt ist der mögliche Wert CSV. Um einen Bericht in JSON zurückzugeben, siehe Get JSON report API.
.. status string Der Status des Berichts. Erlaubte Werte sind GENERATING, READY, FAILED, SCHEDULED.
.. manually_triggered boolean Ob die Berichtserstellung manuell oder systemgeneriert erfolgt.