Bericht erstellen

POST
https://api.digicert.com/reports/v1/report

Verwenden Sie diesen Endpunkt, um einen Bericht zu erstellen.

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

cURL
curl --location --request POST 'https://www.digicert.com/services/v1/reports/preview/report' \
--header 'Content-Type: application/json' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--data-raw '{
    "display_name": "Report_1",
    "schedule": {
        "frequency": “MONTHLY", 
        "weekday_to_run": "TUESDAY", 
        "weekday_frequency": "SECOND",  
        "run_until": "2021-12-24" 
    },
    "format": [
      "CSV"  
    ],
    "report_metadata": {
        "report_type": "orders",
        "columns": [
           {
               "identifier": "account_id"
            },
            {
                "identifier": "number_of_sans"
            },
            {
                "identifier": "certificate_id"
            },
            {
                "identifier": "certificate_validity_days"
            },
            {
                "identifier": "container_id"
            },
            {
                "identifier": "container_name"
            } 
        ],
       "filters":[
        {
        "filter_identifier":"in",
        "column_identifier":"common_name",
        "values":["digiqatest.com"]
        },
        {
        "filter_identifier":"in",
        "column_identifier":"organization_name",
        "values":["win the customer, LLC"]
        },
        {
        "filter_identifier":"in",
        "column_identifier":"status",
        "values":["issued","pending"]
        },
        {
        "filter_identifier":"in",
        "column_identifier":"user_email",
        "values":["dev1@digicert.com"]
        },
        {
        "filter_identifier":"in",
        "column_identifier":"product_name",
        "values":["Secure Site Pro SSL","GeoTrust TrueBusiness ID OV","Secure Site OV"]
        },
        {
        "filter_identifier":"in",
        "column_identifier":"order_placed_via",
        "values":["CertCentral","Api"]
        },
        {
        "filter_identifier":"last_30_days",
        "column_identifier":"order_created_date",
        "values":[]
        },
        {
        "filter_identifier":"in",
        "column_identifier":"certificate_id",
        "values":[3292682707,3292682692,3292682697]
        }
    ],
    "sources": {
      "include_all_sub_accounts": true,
      "sub_accounts": [],
      "divisions":[]
    }        
    }
}
Python
import requests

url = "https://www.digicert.com/services/v1/report"

payload="{\r\n    \"display_name\": \"Report_1\",\r\n    \"schedule\": {\r\n        \"frequency\": “MONTHLY\", \r\n        \"weekday_to_run\": \"TUESDAY\", \r\n        \"weekday_frequency\": \"SECOND\",  \r\n        \"run_until\": \"2021-12-24\" \r\n    },\r\n    \"format\": [\r\n      \"CSV\"  \r\n    ],\r\n    \"report_metadata\": {\r\n        \"report_type\": \"orders\",\r\n        \"columns\": [\r\n           {\r\n               \"identifier\": \"account_id\"\r\n            },\r\n            {\r\n                \"identifier\": \"number_of_sans\"\r\n            },\r\n            {\r\n                \"identifier\": \"certificate_id\"\r\n            },\r\n            {\r\n                \"identifier\": \"certificate_validity_days\"\r\n            },\r\n            {\r\n                \"identifier\": \"container_id\"\r\n            },\r\n            {\r\n                \"identifier\": \"container_name\"\r\n            } \r\n        ],\r\n       \"filters\":[\r\n        {\r\n        \"filter_identifier\":\"in\",\r\n        \"column_identifier\":\"common_name\",\r\n        \"values\":[\"digiqatest.com\"]\r\n        },\r\n        {\r\n        \"filter_identifier\":\"in\",\r\n        \"column_identifier\":\"organization_name\",\r\n        \"values\":[\"win the customer, LLC\"]\r\n        },\r\n        {\r\n        \"filter_identifier\":\"in\",\r\n        \"column_identifier\":\"status\",\r\n        \"values\":[\"issued\",\"pending\"]\r\n        },\r\n        {\r\n        \"filter_identifier\":\"in\",\r\n        \"column_identifier\":\"user_email\",\r\n        \"values\":[\"dev1@digicert.com\"]\r\n        },\r\n        {\r\n        \"filter_identifier\":\"in\",\r\n        \"column_identifier\":\"product_name\",\r\n        \"values\":[\"Secure Site Pro SSL\",\"GeoTrust TrueBusiness ID OV\",\"Secure Site OV\"]\r\n        },\r\n        {\r\n        \"filter_identifier\":\"in\",\r\n        \"column_identifier\":\"order_placed_via\",\r\n        \"values\":[\"CertCentral\",\"Api\"]\r\n        },\r\n        {\r\n        \"filter_identifier\":\"last_30_days\",\r\n        \"column_identifier\":\"order_created_date\",\r\n        \"values\":[]\r\n        },\r\n        {\r\n        \"filter_identifier\":\"in\",\r\n        \"column_identifier\":\"certificate_id\",\r\n        \"values\":[3292682707,3292682692,3292682697]\r\n        }\r\n    ],\r\n    \"sources\": {\r\n      \"include_all_sub_accounts\": true,\r\n      \"sub_accounts\": [],\r\n      \"divisions\":[]\r\n    }        \r\n    }\r\n}"
headers = {
  'Content-Type': 'application/json',
  'X-DC-DEVKEY': '{api_key}',
  'Cookie': 'visid_incap_1323850=KAk7FceETTODSOcubQ6RxzER+V8AAAAAQUIPAAAAAACT+abPwAMvJuYXiY7OiuId'
}

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

print(response.text)
Go
package main

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

func main() {

  url := "https://www.digicert.com/services/v1/report"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
    "display_name": "Report_1",`+"
"+`
    "schedule": {`+"
"+`
        "frequency": “MONTHLY", `+"
"+`
        "weekday_to_run": "TUESDAY", `+"
"+`
        "weekday_frequency": "SECOND",  `+"
"+`
        "run_until": "2021-12-24" `+"
"+`
    },`+"
"+`
    "format": [`+"
"+`
      "CSV"  `+"
"+`
    ],`+"
"+`
    "report_metadata": {`+"
"+`
        "report_type": "orders",`+"
"+`
        "columns": [`+"
"+`
           {`+"
"+`
               "identifier": "account_id"`+"
"+`
            },`+"
"+`
            {`+"
"+`
                "identifier": "number_of_sans"`+"
"+`
            },`+"
"+`
            {`+"
"+`
                "identifier": "certificate_id"`+"
"+`
            },`+"
"+`
            {`+"
"+`
                "identifier": "certificate_validity_days"`+"
"+`
            },`+"
"+`
            {`+"
"+`
                "identifier": "container_id"`+"
"+`
            },`+"
"+`
            {`+"
"+`
                "identifier": "container_name"`+"
"+`
            } `+"
"+`
        ],`+"
"+`
       "filters":[`+"
"+`
        {`+"
"+`
        "filter_identifier":"in",`+"
"+`
        "column_identifier":"common_name",`+"
"+`
        "values":["digiqatest.com"]`+"
"+`
        },`+"
"+`
        {`+"
"+`
        "filter_identifier":"in",`+"
"+`
        "column_identifier":"organization_name",`+"
"+`
        "values":["win the customer, LLC"]`+"
"+`
        },`+"
"+`
        {`+"
"+`
        "filter_identifier":"in",`+"
"+`
        "column_identifier":"status",`+"
"+`
        "values":["issued","pending"]`+"
"+`
        },`+"
"+`
        {`+"
"+`
        "filter_identifier":"in",`+"
"+`
        "column_identifier":"user_email",`+"
"+`
        "values":["dev1@digicert.com"]`+"
"+`
        },`+"
"+`
        {`+"
"+`
        "filter_identifier":"in",`+"
"+`
        "column_identifier":"product_name",`+"
"+`
        "values":["Secure Site Pro SSL","GeoTrust TrueBusiness ID OV","Secure Site OV"]`+"
"+`
        },`+"
"+`
        {`+"
"+`
        "filter_identifier":"in",`+"
"+`
        "column_identifier":"order_placed_via",`+"
"+`
        "values":["CertCentral","Api"]`+"
"+`
        },`+"
"+`
        {`+"
"+`
        "filter_identifier":"last_30_days",`+"
"+`
        "column_identifier":"order_created_date",`+"
"+`
        "values":[]`+"
"+`
        },`+"
"+`
        {`+"
"+`
        "filter_identifier":"in",`+"
"+`
        "column_identifier":"certificate_id",`+"
"+`
        "values":[3292682707,3292682692,3292682697]`+"
"+`
        }`+"
"+`
    ],`+"
"+`
    "sources": {`+"
"+`
      "include_all_sub_accounts": true,`+"
"+`
      "sub_accounts": [],`+"
"+`
      "divisions":[]`+"
"+`
    }        `+"
"+`
    }`+"
"+`
}`)

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

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

  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': 'POST',
  'url': 'https://www.digicert.com/services/v1/report',
  'headers': {
    'Content-Type': 'application/json',
    'X-DC-DEVKEY': '{api_key}',
    'Cookie': 'visid_incap_1323850=KAk7FceETTODSOcubQ6RxzER+V8AAAAAQUIPAAAAAACT+abPwAMvJuYXiY7OiuId'
  },
  body: '{\r\n    "display_name": "Report_1",\r\n    "schedule": {\r\n        "frequency": “MONTHLY", \r\n        "weekday_to_run": "TUESDAY", \r\n        "weekday_frequency": "SECOND",  \r\n        "run_until": "2021-12-24" \r\n    },\r\n    "format": [\r\n      "CSV"  \r\n    ],\r\n    "report_metadata": {\r\n        "report_type": "orders",\r\n        "columns": [\r\n           {\r\n               "identifier": "account_id"\r\n            },\r\n            {\r\n                "identifier": "number_of_sans"\r\n            },\r\n            {\r\n                "identifier": "certificate_id"\r\n            },\r\n            {\r\n                "identifier": "certificate_validity_days"\r\n            },\r\n            {\r\n                "identifier": "container_id"\r\n            },\r\n            {\r\n                "identifier": "container_name"\r\n            } \r\n        ],\r\n       "filters":[\r\n        {\r\n        "filter_identifier":"in",\r\n        "column_identifier":"common_name",\r\n        "values":["digiqatest.com"]\r\n        },\r\n        {\r\n        "filter_identifier":"in",\r\n        "column_identifier":"organization_name",\r\n        "values":["win the customer, LLC"]\r\n        },\r\n        {\r\n        "filter_identifier":"in",\r\n        "column_identifier":"status",\r\n        "values":["issued","pending"]\r\n        },\r\n        {\r\n        "filter_identifier":"in",\r\n        "column_identifier":"user_email",\r\n        "values":["dev1@digicert.com"]\r\n        },\r\n        {\r\n        "filter_identifier":"in",\r\n        "column_identifier":"product_name",\r\n        "values":["Secure Site Pro SSL","GeoTrust TrueBusiness ID OV","Secure Site OV"]\r\n        },\r\n        {\r\n        "filter_identifier":"in",\r\n        "column_identifier":"order_placed_via",\r\n        "values":["CertCentral","Api"]\r\n        },\r\n        {\r\n        "filter_identifier":"last_30_days",\r\n        "column_identifier":"order_created_date",\r\n        "values":[]\r\n        },\r\n        {\r\n        "filter_identifier":"in",\r\n        "column_identifier":"certificate_id",\r\n        "values":[3292682707,3292682692,3292682697]\r\n        }\r\n    ],\r\n    "sources": {\r\n      "include_all_sub_accounts": true,\r\n      "sub_accounts": [],\r\n      "divisions":[]\r\n    }        \r\n    }\r\n}'

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
201 Created
{
  "report_identifier": "e62b02f3-97f9-4fa1-9314-f9ecfdcaf5d7",
  "message": "Successfully created Custom Report"
}
400 Bad request
{
"code": "missing_mandatory_fields",
"message": "Please provide values for mandatory fields"
}
400 Invalid request
{
"code": "invalid_request",
"message": "Please provide correct input for fields: [|display_name has an invalid value|]"
}
400 Already exists
{ 
   "code": "report_exists", 
   "message": "Report already exists"
}
400 Missing field
{
"code": "missing_mandatory_fields",
"message": "Please provide values for mandatory fields"
}
400 Invalid value
{
"code": "invalid_request",
"message": "Please provide correct input for fields: [|run_until has an invalid value|]"
}
400 Invalid date
{
"code": "invalid_date",
"message": "Backdated run_until is not allowed"
}
400 Format unsupported
{
"code": "report_format_inapplicable",
"message": "The given report format is not applicable for the template/report."
}
400 Missing format
{
"code": "missing_mandatory_fields",
"message": "Please provide values for mandatory fields"
}
400 Empty format
{
"code": "invalid_request",
"message": "Please provide correct input for fields: [|format must contain at least 1 item|]"
}
400 Invalid report type
{
"code": "invalid_report_type",
"message": "Invalid report_type specified"
}
400 Invalid column
{
"code": "invalid_column_identifiers",
"message": "Invalid column identifiers specified"
}
400 Invalid schedule
{
"code": "invalid_schedule",
"message": "Provided schedule values are not correct"
}
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"
}

Antragsparameter

Name Antr./Opt. Typ Beschreibung
display_name erforderlich string Der Name, der auf dem Bericht angezeigt werden soll.
schedule erforderlich object Container.
.. frequency erforderlich string Die Häufigkeit der Berichtserstellung. Mögliche Werte: ON_DEMAND, WEEKLY, MONTHLY. Bei den Werten wird zwischen Groß- und Kleinschreibung unterschieden.
.. weekday_to_run erforderlich string Der Wochentag, an dem der Bericht erstellt werden soll. Mögliche Werte: SUNDAY bis SATURDAY. Bei den Werten wird zwischen Groß- und Kleinschreibung unterschieden. Dieser Parameter ist nicht erforderlich, wenn die frequency als ON_DEMAND angegeben ist.
.. weekday_frequency erforderlich string Die angegebene Woche des Monats, in der der Bericht erstellt werden soll. Mögliche Werte: FIRST, SECOND, THIRD, FOURTH, LAST. Bei den Werten wird zwischen Groß- und Kleinschreibung unterschieden.
.. run_until optional date Das Datum, an dem die Erstellung des Berichts beendet werden soll. Format: JJ-MM-TT. Wenn kein Wert angegeben wird, wird die Berichtserstellung nicht gestoppt.
format erforderlich string Der Dateityp des Berichts. Mögliche Werte: CSV und JSON.
report_metadata erforderlich object Container
.. report_type erforderlich string Der Typ des zu erstellenden Berichts.
.. columns erforderlich object Container.
.. .. identifier erforderlich string Der Spaltenbezeichner, der von den APIs der Berichtsbibliothek unterstützt wird. Eine Liste aller unterstützten Spalten finden Sie unter Berichtsbibliothek API-Spalten.
.. filters optional object Container.
.. .. filter_identifier erforderlich string Der Bezeichner, der beim Filtern verwendet werden soll.. Informationen zur Verwendung von Filtern finden Sie unter Erstellen von Bibliotheksberichten mit Filtern.
.. .. column_identifier erforderlich string Die angegebenen Spaltenbezeichner, die für die Filterung verwendet werden sollen. Weitere Informationen zur Verwendung von Filtern finden Sie unter Erstellen von Bibliotheksberichte mit Filtern.
.. .. values erforderlich string/lint Die angegebenen Werte in den Spalten, die für die Filterung verwendet werden sollen. Weitere Informationen zur Verwendung von Filtern finden Sie unter Erstellen von Bibliotheksberichte mit Filtern.
.. sources optional object Container.
.. .. include_all_sub_accounts erforderlich boolean Ob alle Unterkonten in die Berichtserstellung einbezogen werden sollen. Mögliche Werte: TRUE oder FALSE.
.. .. sub_accounts erforderlich integer Die ID des Unterkontos, die angegeben werden muss, um es in die Berichtserstellung einzubeziehen.
.. .. divisions erforderlich integer Die Kontodivision, die in die Berichtserstellung einbezogen werden soll.

Reaktionsparameter

Name Typ Beschreibung
.. report_identifier uuid Die Berichts-ID.
.. message string Die Meldung über die erfolgreiche Erstellung mit dem Anzeigenamen des Berichts.