이 엔드포인트를 사용하여 현재 생성이 예약된 모든 보고서를 받습니다.
이 엔드포인트가 응답하려면 계정에 보고서 라이브러리 기능을 사용해야 합니다.
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 | 보고서 만들기에 연결된 DigiCert 사용자 이름입니다. |
.. 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 | 보고서 생성이 수동 또는 시스템으로 생성인지 여부입니다. |