このエンドポイントを使用して、現在生成予約済のすべてのレポートを取得します。
このエンドポイントが正常に応答するには、レポートライブラリ機能がお使いのアカウントで有効になっている必要があります。
curl -X GET \
'https://www.digicert.com/services/v2/reports/preview/report/history' \
-H 'Content-Type: application/json' \
-H 'X-DC-DEVKEY: {{api_key}}'
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)
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))
}
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);
});
{
"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"
}
]
}
{
"code": "invalid_offset",
"message": "Offset should be zero or positive integer"
}
{
"code": "invalid_limit",
"message": "Limit should be positive integer"
}
{
"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"
}
名前 | 要求/オプション | タイプ | 説明 |
---|---|---|---|
offset | 任意 | integer | 応答に含めるレコード数0 以上か、等しくなければなりません。デフォルト:0. |
limit | 任意 | integer | 応答に含めるページ数デフォルト:100. |
report_display_name | 任意 | string | 表示レポートの名前。複数のレポート名はコンマで区切られます。 |
schedule | 任意 | string |
レポート作成の回数。可能な値:ON_DEMAND, WEEKLY, MONTHLY .
|
status | 任意 | string |
レポートのステータス。すべての予約済レポートは ACTIVE です。
|
report_type | 任意 | string | レポートのタイプ。 |
search | 任意 | string | フィルタが検索に使用する用語。部分検索をサポートしています。 |
sort_by | 任意 | string |
ソーティングを行う元となるパラメータ。ソーティング用のサポート対象パラメータ。report_display_name, report_type, schedule, format . sort_by パラメータを入力しない場合、デフォルトは report_start_date です。
|
sort_direction | 任意 | string |
方向は ASC (昇順) または DESC (降順) にできます。デフォルトは ASC です。,ただし、ソーティング列と sort_direction が両方とも空でない場合。この場合、ソーティングは report_start_date で (デフォルトソーティング列) で DESC 順で行われます。
|
名前 | タイプ | 説明 |
---|---|---|
page | object | コンテナ |
.. total | integer | 生成予約済レポートの数。 |
.. limit | integer | 応答に含めるページ数デフォルト:100. |
.. offset | integer | 応答に含めるレコード数0 以上か、等しくなければなりません。デフォルト:0. |
report_history | container | コンテナ |
.. report_display_name | string | 表示レポートの名前。複数のレポート名はコンマで区切られます。 |
.. report_identifier | string | [レポート API を作成する] の応答に表示されるレポート ID。 |
.. report_run_identifier | string | レポートの生成に関連づけられた ID。この値は、[レポート API を作成する] に表示されます。 |
.. created_by_user_id | string | レポート作成者に関連づけられたユーザー ID。 |
.. created_date | string | 次の形式のタイプスタンプを含む、レポートの作成日。YY-MM-DD HH--MM-SS. |
.. created_by_user_name | string | レポート作成に関連づけられたデジサート ユーザー名。 |
.. report_type | string | レポートタイプ。詳細は、「サポート対象のレポートタイプ API を一覧表示する」 を参照してください。 |
.. report_type_display_name | string | レポートタイプとして指定した名前。 |
.. report_start_date | date | レポート作成の開始日。形式:YY-MM-DD. |
.. report_end_date | date | レポート作成の終了日。形式:YY-MM-DD. |
.. schedule | string |
レポート作成の回数。可能な値:ON_DEMAND, WEEKLY, MONTHLY .
|
.. format | string |
レポートの形式。このエンドポイントでは、可能な値は、CSV です。JSON でレポートを返すには、「JSON レポート API を取得する」 を参照してください。
|
.. status | string |
レポートのステータス。許可値は、GENERATING, READY, FAILED, SCHEDULED です。
|
.. manually_triggered | boolean | レポート生成を手動にするか、システム生成にするか。 |