使用此端點修改報告範本。使用來自「建立報告」端點的回應提供 report-identifier
。
若要讓此端點成功回應,您必須在您的帳戶中啟用「報告程式庫」功能。
curl --location -g --request PUT 'https://www.digicert.com/services/v1/reports/preview/report/{report-indentifier}' \
--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":[]
}
}
}
import requests
url = "https://www.digicert.com/services/v1/report/{report-indentifier}"
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("PUT", url, headers=headers, data=payload)
print(response.text)
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://www.digicert.com/services/v1/report/%7Breport-indentifier%7D"
method := "PUT"
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))
}
var request = require('request');
var options = {
'method': 'PUT',
'url': 'https://www.digicert.com/services/v1/report/{report-indentifier}',
'headers': {
'Content-Type': 'application/json',
'X-DC-DEVKEY': '{api_key}',
'Cookie': 'visid_incap_1323850=KAk7FceETTODSOcubQ6RxzER+V8AAAAAQUIPAAAAAACT+abPwAMvJuYXiY7OiuId'
},
body: JSON.stringify({"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":[]}}})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
<BLANK>
{
"code": "missing_mandatory_fields",
"message": "Please provide values for mandatory fields"
}
{
"code": "invalid_request",
"message": "Please provide correct input for fields: [|display_name has an invalid value|]"
}
{
"code": "report_exists",
"message": "Report already exists"
}
{
"code": "invalid_request",
"message": "Please provide correct input for fields: [|run_until has an invalid value|]"
}
{
"code": "invalid_date",
"message": "Backdated run_until is not allowed"
}
{
"code": "report_format_inapplicable",
"message": "The given report format is not applicable for the template/report."
}
{
"code": "invalid_request",
"message": "Please provide correct input for fields: [|format must contain at least 1 item|]"
}
{
"code": "invalid_report_type",
"message": "Invalid report_type specified"
}
{
"code": "invalid_column_identifiers",
"message": "Invalid column identifiers specified"
}
{
"code": "invalid_schedule",
"message": "Provided schedule values are not correct"
}
名稱 | 必填/選填 | 類型 | 說明 |
---|---|---|---|
display_name | 必填 | string | 報告的指定顯示名稱。 |
schedule | 必填 | object | 容器。 |
.. frequency | 必填 | string |
建立報告的頻率。可能的值:ON_DEMAND, WEEKLY, MONTHLY . 值要區分大小寫。
|
.. weekday_to_run | 必填 | string |
建立報告的一周的日期。可能的值:SUNDAY 到 SATURDAY .值要區分大小寫。
|
.. weekday_frequency | 必填 | string |
指定在一個月中的第幾周產生報告。可能的值: FIRST , SECOND , THIRD , FOURTH , LAST . 值要區分大小寫。
|
.. run_until | 必填 | string | 日期報告產生停止。格式:年-月-日。 |
format | 必填 | string |
報告的格式。關於此端點,可能的值是 CSV 。若要在 JSON 中傳回報告,請參閱取得 JSON 報告 API。
|
report_metadata | 必填 | object | 容器。 |
.. report_type | 必填 | string | 要修改的報告類型。 |
.. columns | 必填 | object | 容器。 |
.. .. identifier | 必填 | string | 報告程式庫 API 支援的欄識別碼。關於所有支援的欄的清單,請參閱報告程式庫 API 欄。 |
.. filters | 選填 | object | 容器。 |
.. .. filter_identifier | 必填 | string | 篩選中使用的識別碼。如需有關使用篩選器的資訊,請參閱「使用篩選器建立程式庫報告」。 |
.. .. coliumn_identifier | 必填 | string | 用於篩選的指定欄識別碼。如需更多有關使用篩選器的資訊,請參閱「使用篩選器建立程式庫報告」。 |
.. .. values | 必填 | string/lint | 用於篩選的欄中的指定值。如需更多有關使用篩選器的資訊,請參閱「使用篩選器建立程式庫報告」。 |
.. sources | 選填 | object | 容器。 |
.. .. include_all_sub_accounts | 必填 | boolean |
是否在建立報告中納入所有子帳戶。可能的值:TRUE 或 FALSE 。
|
.. .. sub_accounts | 必填 | integer | 若要將子帳戶納入報告建立中,必須提供子帳戶的 ID。 |
.. .. divisions | 必填 | integer | 納入報告建立中的帳戶分部。 |
名稱 | 必填/選填 | 類型 | 說明 |
---|---|---|---|
report-identifier | 必填 | uuid | 顯示在建立報告 API 的回應中的報告 ID。 |