このエンドポイントを使用して、レポート ID を提供してレポートについての情報を返します。
このエンドポイントが正常に応答するには、レポートライブラリ機能がお使いのアカウントで有効になっている必要があります。
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}}'
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)
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))
}
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);
});
{
"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
}
}
{
"code": "user_authentication_error",
"message": "User is not authenticated."
}
{
"code": "user_forbidden",
"message": "User does not have the required permission."
}
{
"code": "custom_reports_not_enabled",
"message": "Custom reports is not enabled"
}
{
"code": "reports_not_found",
"message": "Report with the given identifier does not exist."
}
404 page not found
名前 | 要求/オプション | タイプ | 説明 |
---|---|---|---|
report-identifier | 必須 | string | [レポート API を作成する] の応答に表示されるレポート ID。 |
名前 | タイプ | 説明 |
---|---|---|
report | object | コンテナ |
report_display_name | string | レポートの指定名。 |
.. report_identifier | string | [レポート API を作成する] の応答に表示されるレポート ID。 |
.. created_by_user_id | string | レポート作成者に関連づけられるユーザー ID。 |
.. created_date | string | 次の形式のタイプスタンプを含む、レポートの作成日。YY-MM-DD HH--MM-SS. |
.. created_by_user_name | string | レポート作成に関連づけられたユーザー名。 |
.. report_metadata | object | コンテナ |
.. .. columns | object | レポートで指定した列のタイプ。 |
.. .. .. identifier | string | レポートライブラリ API がサポートする列識別子。すべてのサポート対象列のリストについては、「レポートライブラリ API 列」 を参照してください。 |
.. .. report_type | string | レポートのタイプ。 |
.. schedule | object | コンテナ |
.. .. frequency | string |
レポート作成の回数。可能な値:ON_DEMAND, WEEKLY, MONTHLY . 値は、ケースセンシティブです。
|
.. .. weekday_to_run | string |
レポート作成の曜日。可能な値:SUNDAY to SATURDAY .値は、ケースセンシティブです。
|
.. .. weekday_frequency | string |
平日ごとのレポート作成の回数。可能な値:FIRST ,SECOND ,THIRD ,FOURTH ,LAST . 値は、ケースセンシティブです。
|
.. .. run_until | date | このレポート作成を停止する日付。形式:YY-MM-DD. |
.. next_run_date | date | このレポート作成を再開する日付。形式:YY-MM-DD. |
.. format | string |
レポートの形式。このエンドポイントでは、可能な値は、CSV です。JSON でレポートを返すには、「JSON レポート API を取得する」 を参照してください。
|
.. status | string |
レポートのステータス。すべての予約済レポートは ACTIVE です。
|