Obtenir un rapport par son identifiant

GET
https://api.digicert.com/reports/v1/report/{{report_identifier}}

Appelez ce point de terminaison pour renvoyer des informations sur un rapport en fournissant son identifiant.

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/{{report_identifier}}' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'
Python
import requests

url = "https://www.digicert.com/services/v1/reports/preview/report/{{report-identifier}}"

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/{{report-identifier}}"
  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/{{report-identifier}}',
  '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);
});
200 OK
{
    "report": {
        "report_display_name": "RPT01",
        "report_identifier": "b80de6e4-f085-4488-a47f-b7b5ea07e05e",
        "created_by_user_id": 10192361,
        "created_by_user_name": "venkat patil",
        "created_date": "2021-01-13 09:43:17",
        "report_metadata": {
            "columns": [
                {
                    "identifier": "account_id"
                },
                {
                    "identifier": "number_of_sans"
                },
                {
                    "identifier": "certificate_id"
                },
                {
                    "identifier": "certificate_validity_days"
                },
                {
                    "identifier": "container_id"
                },
                {
                    "identifier": "container_name"
                }
            ],
            "report_type": "orders"
        },
        "schedule": {
            "frequency": "WEEKLY", //Possible values ON_DEMAND,WEEKLY,MONTHLY
            "weekday_to_run": "WEDNESDAY", // Possible values SUNDAY to SATURDAY, ""
            "weekday_frequency": "", // Possible values FIRST, SECOND, THIRD, FOURTH, LAST, ""
            "run_until": "2021-12-23"
        },
        "next_run_date": "2021-01-20",
         "format": [
            "CSV" // Possible value only CSV
        ],
        "status": "ACTIVE"  // Always ACTIVE
    }
}
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"
}
404 Report not found
{
    "code": "reports_not_found",
    "message": "Report with the given identifier does not exist."
}
404 Page not found
404 page not found

Paramètres du chemin

Nom Obligatoire/facultatif Type Description
report-identifier Obligatoire string Identifiant du rapport, affiché dans la réponse de l’API Créer un rapport.

Paramètres de réponse

Nom Type Description
report object Conteneur.
report_display_name string Nom spécifié pour le rapport.
.. report_identifier string Identifiant de rapport affiché dans la réponse de 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 associé à la création du rapport.
.. report_metadata object Conteneur.
.. .. columns object Types des colonnes spécifiées dans le rapport.
.. .. .. identifier string L’identificateur de colonne pris en charge par l’API Bibliothèque de rapports Pour obtenir la liste de toutes les colonnes prises en charge, consultez la page Colonnes de l’API Bibliothèque de rapports.
.. .. report_type string Type de rapport.
.. schedule object Conteneur.
.. .. frequency string Fréquence de la création de rapport. Valeurs possibles : ON_DEMAND, WEEKLY, MONTHLY. Ces valeurs sont sensibles à la casse.
.. .. weekday_to_run string Jour de la semaine auquel créer le rapport. Valeurs possibles : Du SUNDAY au SATURDAY. Ces valeurs sont sensibles à la casse.
.. .. weekday_frequency string Nombre de fois que le rapport doit être créé par jour de la semaine. Valeurs possibles : FIRST, SECOND, THIRD, FOURTH, LAST. Ces valeurs sont sensibles à la casse.
.. .. run_until date Date à laquelle arrêter la création de ce rapport. Format : AA-MM-JJ.
.. next_run_date date Date à laquelle reprendre la création de ce rapport. Format : AA-MM-JJ.
.. 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. Tous les rapports planifiés sont indiqués ACTIVE.